プラットフォーム API 概要
プラットフォーム API を使うと、スクリプトやサードパーティシステムがあなた本人として RouteAPI アカウントを管理できます。残高の照会、API Key の作成と管理、アカウントログ（CSV / JSONL エクスポート対応）・使用量統計の確認が可能です。
Base URL: https://www.routeapi.ai/api/open/v1
認証方式: Authorization: Bearer rat_xxxx — マネジメントキーの作成と保管は プラットフォーム API の認証 を参照してください。
リクエスト例
Section titled “リクエスト例”curl https://www.routeapi.ai/api/open/v1/balance \ -H "Authorization: Bearer $ROUTEAPI_MANAGEMENT_KEY"/api/open/v1 配下のすべてのエンドポイントは同じヘッダーを受け付けます。レスポンスは統一された { success, message, data } ボディです。この形式、エラーコード、レート制限については エラーと制限 を参照してください。
金額フィールドはすべてサイトの表示通貨による金額で、小数点以下 2 桁です（例: 10.00）。通貨は 残高を照会する で返されます。各金額は個別に四捨五入されるため、合計金額と行ごとの金額の合計が ±0.01 ずれる場合があります。
ページネーション
Section titled “ページネーション”一覧系エンドポイントは共通のページ番号方式を使用します。
| パラメーター | 型 | デフォルト | 説明 |
|---|---|---|---|
p | integer | 1 | ページ番号。1–1000000 |
page_size | integer | 10 | 1 ページあたりの件数。1–1000 |
明示的に指定した p / page_size は上記の範囲内である必要があります。整数でない値、0、負の値、範囲外の値は 400 invalid_request を返し、デフォルト値への置き換えや切り捨ては行いません。レスポンスの page / page_size が実際に適用された値です。
ログ系エンドポイントの total は最大 10000 までで、それを超える場合は常に 10000 になります。完全なデータが必要な場合は時間範囲を分けて取得してください。
クエリ文字列のエンコード
Section titled “クエリ文字列のエンコード”クエリ文字列に未エンコードのセミコロン ; を含めないでください。%3B にエンコードしない場合、リクエスト全体が 400 invalid_request になります。% は %25、空白は + または %20 にエンコードしてください。
エンドポイント一覧
Section titled “エンドポイント一覧”以下のパスは https://www.routeapi.ai/api/open/v1 からの相対パスです。
| メソッド | パス | 説明 |
|---|---|---|
| GET | /balance | 残高を照会する |
API Keys
Section titled “API Keys”| メソッド | パス | 説明 |
|---|---|---|
| GET | /keys | API Key を一覧表示する |
| GET | /keys/:id | API Key を取得する |
| GET | /keys/:id/key | API Key の完全な値を取得する |
| POST | /keys | API Key を作成する |
| PATCH | /keys/:id | API Key を更新する |
| DELETE | /keys/:id | API Key を削除する |
| メソッド | パス | 説明 |
|---|---|---|
| GET | /logs | アカウントログを照会する |
| GET | /logs/export | ログのエクスポート |
| メソッド | パス | 説明 |
|---|---|---|
| GET | /usage | 使用量統計を照会する |
| GET | /usage/models | モデル別の使用量を照会する |
| GET | /usage/keys | Key 別の使用量を照会する |