ワークフロー実行リストを取得

ワークフローの実行ログリストを取得するために使用します。ワークフローは API Key による自動認証で特定されるため、workflow_id を別途渡す必要はありません。

ID 名称	説明
log_id	ワークフロー実行ログ ID。
workflow_run_id	ワークフローの単回実行 ID。1 回のワークフロー実行を識別するために使用されます。
input	今回のワークフロー実行の入力内容。
output	今回のワークフロー実行の出力内容。

メソッド

GET

URL

https://api-${endpoint}.gptbots.ai/v1/workflow/run/logs

認証

Workflow API Key を使用して呼び出しを検証します。

リクエスト

例

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/workflow/run/logs?conversation_type=API&user_id=your_user_id&start_time=1785125443602&end_time=1785125447498&page=1&page_size=10' \ -H 'Authorization: Bearer ${API Key}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/workflow/run/logs?conversation_type=API&user_id=your_user_id&start_time=1785125443602&end_time=1785125447498&page=1&page_size=10' \
  -H 'Authorization: Bearer ${API Key}'

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

ヘッダ

フィールド	型	説明
Authorization	Bearer ${API Key}	`Authorization: Bearer ${API Key}` を使用して呼び出しを検証します。Workflow API Key を使用してください。

リクエストパラメータ

フィールド	型	必須	説明
conversation_type	string	Y	実行元のタイプ。サポート：`ALL`、`API`、`AGENT`、`SHARE`、`C_WORKFLOW`。試運転の `DEBUG` はサポートされません。
user_id	string	N	ユーザー識別子。指定したユーザーのワークフロー実行記録を絞り込むために使用します。
start_time	number	Y	照会開始時間、ミリ秒タイムスタンプ。
end_time	number	Y	照会終了時間、ミリ秒タイムスタンプ。
page	number	Y	ページ番号。`1` から開始します。
page_size	number	Y	1 ページあたりの件数。取り得る範囲は `10-100`。

レスポンス

例

{ "list": [ { "log_id": "6a66da44435da934b2e67e49", "workflow_run_id": "6a66da44435da934b2e67e49", "input": "{}", "output": "{\"output\":\"{\\\"text\\\":\\\"Workflow output text\\\",\\\"image\\\":[],\\\"audio\\\":[]}\"}" } ], "total": 1 }

                      
                      {
  "list": [
    {
      "log_id": "6a66da44435da934b2e67e49",
      "workflow_run_id": "6a66da44435da934b2e67e49",
      "input": "{}",
      "output": "{\"output\":\"{\\\"text\\\":\\\"Workflow output text\\\",\\\"image\\\":[],\\\"audio\\\":[]}\"}"
    }
  ],
  "total": 1
}

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

成功レスポンス

フィールド	型	説明
list	array	ワークフロー実行ログリスト。
total	number	照会条件に一致する総件数。
list[].log_id	string	ワークフロー実行ログ ID。
list[].workflow_run_id	string	ワークフローの単回実行 ID。
list[].input	string	入力内容、JSON 文字列。
list[].output	string	出力内容、JSON 文字列。

失敗レスポンス

フィールド	型	説明
code	int	エラーコード。
message	string	エラー詳細。

エラーコード

Code	Message
40000	パラメータエラー
40001	リクエストが多すぎます
40101	Header Authorization is empty
40127	Developer authentication failed