メインコンテンツへスキップ
POST
/
workflows
/
run
A valid request URL is required to generate request examples
{
  "task_id": "c3800678-a077-43df-a102-53f23ed20b88",
  "workflow_run_id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156",
  "data": {
    "id": "fb47b2e6-5e43-4f90-be01-d5c5a088d156",
    "workflow_id": "7c3e33d4-2a8b-4e5f-9b1a-d3c6e8f12345",
    "status": "succeeded",
    "outputs": {
      "result": "Bonjour le monde"
    },
    "error": null,
    "elapsed_time": 1.23,
    "total_tokens": 150,
    "total_steps": 3,
    "created_at": 1705407629,
    "finished_at": 1705407630
  }
}

承認

Authorization
string
header
必須

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例:Authorization: Bearer {API_KEY}API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

ボディ

application/json
inputs
object
必須

ワークフロー入力変数のキーと値のペアです。ファイル型変数の値は、typetransfer_method、および url または upload_file_id を持つファイルオブジェクトの配列である必要があります。アプリが期待する変数名と型については、アプリケーションのパラメータ情報を取得 レスポンスの user_input_form フィールドを参照してください。

user
string
必須

開発者のルールで定義されるユーザー識別子で、アプリケーション内で一意である必要があります。この識別子はデータアクセスの範囲を限定します——ワークフロー実行とファイルは同じ user 値でクエリした場合にのみ表示されます。

response_mode
enum<string>

レスポンスモードです。同期レスポンスには blocking(Cloudflare タイムアウトは 100 s)、サーバー送信イベントには streaming を使用します。省略した場合、デフォルトはブロッキング動作になります。

利用可能なオプション:
streaming,
blocking
files
object[] | null

ファイルリストです。ファイルとテキストを組み合わせて入力する場合に適しており、モデルが Vision 機能をサポートしている場合にのみ使用できます。ローカルファイルを添付するには、まず ファイルをアップロード でアップロードし、返された idupload_file_id として transfer_method: local_file で使用します。

レスポンス

リクエスト成功。コンテンツタイプと構造はリクエストの response_mode パラメータに依存します。

  • response_modeblocking の場合、 application/jsonWorkflowBlockingResponse オブジェクトを返します。
  • response_modestreaming の場合、 text/event-streamChunkWorkflowEvent オブジェクトのストリームを返します。
task_id
string<uuid>

進行中の実行のタスク ID です。ワークフロータスクを停止 と組み合わせて、実行中のワークフローをキャンセルします。実行中のみ有効です。

workflow_run_id
string<uuid>

このワークフロー実行記録の永続的な識別子です。ワークフロー実行詳細を取得 と組み合わせて、実行後に結果を取得します。

data
object