Workflow 実行のクレジット消費一覧を取得

Workflow 実行のクレジット消費一覧を取得

このインターフェースを使用すると、指定されたワークフローの指定期間内の実行クレジット消費詳細を取得できます。runId ごとに集計され、最大で過去30日分のデータが返されます。

リクエスト方式

GET

呼び出しアドレス

https://api.gptbots.ai/v1/account/workflow/run/credits

認証方法

詳細は API 概要 の認証方式の説明を参照してください。

呼び出し頻度

このインターフェースは組織プランの「統計系 API」の1分あたりのクォータにカウントされ、その他の統計系インターフェース(組織レベルの統計インターフェースを含む)とクォータを共有します。上限を超えると、40008 が返されます。

リクエスト

リクエスト例

curl -X GET 'https://api.gptbots.ai/v1/account/workflow/run/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/workflow/run/credits?start_time=1774837924000&end_time=1775183447000&page=1&page_size=20' \
  -H 'Authorization: Bearer your_apikey'

                    
このコードブロックをポップアップで表示

リクエストヘッダー

フィールド 型 説明
Authorization Bearer ${token} Authorization: Bearer ${token} を使用して呼び出し認証を行います。トークンとして API キー ページで取得したキーを使用してください。

リクエストパラメータ

フィールド 型 必須 説明
start_time long はい 検索開始時間、ミリ秒タイムスタンプ。
end_time long はい 検索終了時間、ミリ秒タイムスタンプ。start_time と end_time の間隔は30日を超えてはいけません。
page int いいえ ページ番号、デフォルトは 1。
page_size int いいえ 1ページあたりの件数、デフォルトは 20、最大は 100。
run_id string いいえ ワークフローの実行 ID。

レスポンス

レスポンス例

{ "list": [ { "run_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "run_start_time": 1774838000000, "chat": 2.10, "anonymization": 0, "asr": 0.50, "tts": 0, "rerank": 0.30, "database_processing": 0, "tool_call": 0.80, "knowledge_doc_indexing": 0, "question_tag": 0, "total": 3.70 } ], "total": 1, "page": 1, "page_size": 20, "start_time": 1774837924000, "end_time": 1775183447000 }
                      
                      {
    "list": [
        {
            "run_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
            "run_start_time": 1774838000000,
            "chat": 2.10,
            "anonymization": 0,
            "asr": 0.50,
            "tts": 0,
            "rerank": 0.30,
            "database_processing": 0,
            "tool_call": 0.80,
            "knowledge_doc_indexing": 0,
            "question_tag": 0,
            "total": 3.70
        }
    ],
    "total": 1,
    "page": 1,
    "page_size": 20,
    "start_time": 1774837924000,
    "end_time": 1775183447000
}

                    
このコードブロックをポップアップで表示

成功レスポンス

フィールド 型 説明
list list クレジット消費の明細リスト。
run_id string ワークフローの実行 ID。
run_start_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 質問タグ付けのクレジット消費。
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 システム内部エラー