クレジット消費の詳細取得方法 - GPTBots
クレジット消費の詳細取得方法 - GPTBots
指定した期間内におけるエージェントのクレジット消費の詳細を日別に取得します。
注:最大で過去90日分までのデータを取得できます。
リクエストメソッド
GET
リクエストURL
https://api-${endpoint}.gptbots.ai/v1/account/bill/page
リクエスト認証
認証方法の説明についてはAPI Overviewをご参照ください。
リクエスト
リクエスト例
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/account/bill/page?page=1&page_size=10&start_time=1732982400000&end_time=1735660799999' \
-H 'Authorization: Bearer ${API Key}'
curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/account/bill/page?page=1&page_size=10&start_time=1732982400000&end_time=1735660799999' \
-H 'Authorization: Bearer ${API Key}'
このコードブロックをポップアップで表示
リクエストヘッダー
| フィールド | タイプ | 説明 |
|---|---|---|
| Authorization | Bearer ${API Key} | 認証には Authorization: Bearer ${API Key} を使用してください。トークンはAPIキーページから取得できます。 |
リクエストボディ
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
| start_time | String | 必須 | 開始時間 |
| end_time | String | 必須 | 終了時間 |
レスポンス
レスポンス例
[
{
"date": "2022-02-02",
"total": 100,
"chat": 10,
"knowledge_doc_indexing": 10,
"knowledge_doc_storage": 10,
"rerank": 10,
"database_processing": 10,
"tool_call": 10,
"asr": 10,
"tts": 10
},
{
"date": "2022-02-03",
"total": 100,
"chat": 10,
"knowledge_doc_indexing": 10,
"knowledge_doc_storage": 10,
"rerank": 10,
"database_processing": 10,
"tool_call": 10,
"asr": 10,
"tts": 10
}
]
[
{
"date": "2022-02-02",
"total": 100,
"chat": 10,
"knowledge_doc_indexing": 10,
"knowledge_doc_storage": 10,
"rerank": 10,
"database_processing": 10,
"tool_call": 10,
"asr": 10,
"tts": 10
},
{
"date": "2022-02-03",
"total": 100,
"chat": 10,
"knowledge_doc_indexing": 10,
"knowledge_doc_storage": 10,
"rerank": 10,
"database_processing": 10,
"tool_call": 10,
"asr": 10,
"tts": 10
}
]
このコードブロックをポップアップで表示
成功時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| start_date | String | 開始日 |
| end_date | String | 終了日 |
| total | Number | 消費されたクレジットの合計 |
| chat | Number | テキストチャットで消費されたクレジット |
| knowledge_doc_indexing | Number | ナレッジドキュメントのインデックス作成で消費されたクレジット |
| knowledge_doc_storage | Number | ナレッジドキュメントの保存で消費されたクレジット |
| rerank | Number | リランキング処理で消費されたクレジット |
| database_processing | Number | データベース処理で消費されたクレジット |
| tool_call | Number | ツール呼び出しで消費されたクレジット |
| asr | Number | 音声認識（ASR）で消費されたクレジット |
| tts | Number | 音声合成（TTS）で消費されたクレジット |
エラー時のレスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| code | Int | エラーコード |
| message | String | エラーメッセージ |