開発者向け
DXRating API とエージェント向けリソース
DXRating が公開する API と機械可読な検出情報を使って、連携機能、ツール、エージェントのワークフローを構築できます。
はじめに
利用可能な操作、入力、出力については、OpenAPI スキーマを正式な仕様として参照してください。
- API ベース URL
- https://miruku.dxrating.net/api/v1
- OpenAPI スキーマ
- https://miruku.dxrating.net/spec.json
- 対話型 API ドキュメント
- https://miruku.dxrating.net/docs
- RFC 9727 API カタログ
- https://dxrating.net/.well-known/api-catalog
- エージェント向けガイド
- https://dxrating.net/llms.txt
アクセスと安定性
公開カタログ
公開カタログのエンドポイントと API ドキュメントは、DXRating アカウントなしで利用できます。
認証が必要な操作
一部のコミュニティ機能やアカウント関連の操作には DXRating のセッションが必要です。各操作の要件は OpenAPI スキーマで確認してください。
公開ベータ
API は今後も変更される可能性があります。最新のスキーマに対して連携を検証し、互換性のある追加に対応してください。
エージェントによる検出
エージェントは API カタログと llms.txt から同じ API を検出できます。DXRating をインストール済みの環境では、エンドポイントを推測せず、公開されたツールスキーマを使用してください。
連携時の注意
- カタログデータの取得には ETag と条件付きリクエストを使用してください。
- 譜面ごとの結果を示す場合は、DXRating の正規譜面 URL を返すか引用してください。
- 条件付きリクエストや用途に合ったエンドポイントで十分な場合は、カタログ全体を繰り返し取得しないでください。