Agent の会話クレジット消費一覧を取得
Agent の会話クレジット消費一覧を取得
このインターフェースを通じて、指定したAgentが指定期間内に消費した対話クレジットの詳細を取得できます。conversationIdごとに集計され、最大で30日分のデータを返します。
リクエスト方法
GET
呼び出しURL
https://api.gptbots.ai/v1/account/agent/conversation/credits
認証方法
詳細はAPI概要の認証方法の説明を参照してください。
呼び出し頻度
このインターフェースは組織プランの「統計系API」の1分あたりのクォータにカウントされ、他の統計系インターフェース(組織レベルの統計インターフェースを含む)と共用されます。超過した場合は40008が返されます。
リクエスト
リクエスト例
curl -X GET 'https://api.gptbots.ai/v1/account/agent/conversation/credits?start_time=1774837924000&end_time=1775183447000&page=1&page_size=20' \
-H 'Authorization: Bearer your_apikey'
curl -X GET 'https://api.gptbots.ai/v1/account/agent/conversation/credits?start_time=1774837924000&end_time=1775183447000&page=1&page_size=20' \
-H 'Authorization: Bearer your_apikey'
このコードブロックをポップアップで表示
リクエストヘッダー
| フィールド | タイプ | 説明 |
|---|---|---|
| Authorization | Bearer ${token} | Authorization: Bearer ${token}を使用して呼び出し認証を行います。APIキーのページでキーを取得し、tokenとして使用してください。 |
リクエストパラメータ
| フィールド | タイプ | 必須 | 説明 |
|---|---|---|---|
| start_time | long | はい | クエリ開始時間、ミリ秒タイムスタンプ。 |
| end_time | long | はい | クエリ終了時間、ミリ秒タイムスタンプ。start_timeとend_timeの間隔は30日を超えないようにしてください。 |
| page | int | いいえ | ページ番号、デフォルトは1。 |
| page_size | int | いいえ | 1ページあたりの件数、デフォルトは20、最大は100。 |
| conversation_id | string | いいえ | 会話ID。 |
レスポンス
レスポンス例
{
"list": [
{
"conversation_id": "6830a1f2e4b0f1a2b3c4d5e6",
"conversation_create_time": 1774838000000,
"chat": 1.50,
"anonymization": 0,
"asr": 0,
"tts": 0,
"rerank": 0.30,
"database_processing": 0,
"tool_call": 0.20,
"knowledge_doc_indexing": 0,
"question_tag": 0,
"moderation": 0.01,
"total": 2.0
}
],
"total": 1,
"page": 1,
"page_size": 20,
"start_time": 1774837924000,
"end_time": 1775183447000
}
{
"list": [
{
"conversation_id": "6830a1f2e4b0f1a2b3c4d5e6",
"conversation_create_time": 1774838000000,
"chat": 1.50,
"anonymization": 0,
"asr": 0,
"tts": 0,
"rerank": 0.30,
"database_processing": 0,
"tool_call": 0.20,
"knowledge_doc_indexing": 0,
"question_tag": 0,
"moderation": 0.01,
"total": 2.0
}
],
"total": 1,
"page": 1,
"page_size": 20,
"start_time": 1774837924000,
"end_time": 1775183447000
}
このコードブロックをポップアップで表示
成功レスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| list | list | クレジット消費明細リスト。 |
| conversation_id | string | 会話ID。 |
| conversation_create_time | long | 会話作成時間(ミリ秒タイムスタンプ)、会話履歴が削除された場合は null。 |
| chat | decimal | 対話(LLMチャット)クレジット消費。 |
| anonymization | decimal | 匿名化クレジット消費。 |
| asr | decimal | 音声認識(ASR)クレジット消費。 |
| tts | decimal | テキスト読み上げ(TTS)クレジット消費。 |
| rerank | decimal | ベクトル再ランキングクレジット消費。 |
| database_processing | decimal | データベース処理クレジット消費。 |
| tool_call | decimal | ツール呼び出しクレジット消費。 |
| knowledge_doc_indexing | decimal | ナレッジベースインデックスクレジット消費。 |
| question_tag | decimal | 質問タグ付けクレジット消費。 |
| moderation | decimal | コンテンツ審査クレジット消費。 |
| total | decimal | この会話の合計クレジット消費。 |
| total | long | 条件に一致する会話の総数(ページネーション用)。 |
| page | int | 現在のページ番号。 |
| page_size | int | 1ページあたりの件数。 |
| start_time | long | 検索開始時間。 |
| end_time | long | 検索終了時間。 |
失敗レスポンス
| フィールド | タイプ | 説明 |
|---|---|---|
| code | int | エラーコード。 |
| message | string | エラーの説明情報。 |
エラーコード
| Code | Message |
|---|---|
| 40000 | パラメータエラー |
| 40001 | 時間範囲が不正(30日を超える) |
| 50000 | システム内部エラー |
