ElevenCreativeImage & VideoFlowsTemplatesRuns

テンプレート実行を作成

フローテンプレートの実行を開始します。`version_id`を指定するとスナップショットを固定できます。省略するか`latest`を指定すると、公開済みの最新バージョンを実行します。入力値は、入力ポートIDをキーとして`inputs`に設定します。レスポンスには初期状態の実行が含まれ、すべての出力が`outputs`内でポートIDごとにすでに一覧表示されています。`webhook`を指定すると、`status`が`completed`または`failed`になった際に完了した実行を含む`flows_template_run`イベントを受け取れます。これが推奨される待機方法です。指定しない場合は、`status`が終端状態になるまで適度な間隔で`GET /v1/flows/templates/{template_id}/runs/{run_id}`を取得してください。

パスパラメータ

template_idstring必須

ElevenLabsアプリまたはGET /v1/flows/templatesに表示されるテンプレートのID。

ヘッダー

xi-api-keystringオプション

リクエスト

This endpoint expects an object.
inputsmap from strings to strings or booleans or integers or doubles or objects or lists of TemplateRunInput必須

入力ポートIDをキーとする入力値です。実行するバージョンのすべての入力ポートを指定する必要があり、不足または不明なIDは拒否されます。入力のないテンプレートには{}を渡してください。

version_idstring or nullオプション>=1 character

実行するテンプレートスナップショット。特定のバージョンIDを渡してそのスナップショットを固定するか、latest（省略時のデフォルト）を渡してテンプレートの最新公開バージョンを実行します。固定できるのは公開済みバージョンのみですが、テンプレートのオーナーは公開前の試用として未公開の保存済みスナップショットも固定できます。ライブドラフトがこのAPIで実行されることはありません。

webhookobject or nullオプション

含めると、実行のstatusがcompletedまたはfailedに達した時点で、実行結果をワークスペースに設定されたflows Webhookへ送信します。実行全体につきイベントは1件です。flows_template_runイベントのdataは、GET /v1/flows/templates/{template_id}/runs/{run_id}の最終応答と一致します。

レスポンス

成功レスポンス。

idstring

実行の一意の識別子です。

template_idstring

この実行で使用されたテンプレート。複数のテンプレートを実行するWebhookコンシューマーは、実行とテンプレートの対応表を保持せずに各実行を区別できます。

version_idstring

この実行で使用されたテンプレートバージョン。実行の作成時に解決されるため、latestで開始した実行には実際に使用されたバージョンが記録されます。

statusenum

出力から集約された実行のステータス。出力が開始するまではpending、いずれかの出力が未完了の間はgenerating、すべての出力が完了するとcompleted、すべての出力が終了し少なくとも1つが失敗するとfailedです。completedとfailedは終端ステータスであり、実行がいずれかに到達するとflows_template_runWebhookが発火します。

許可された値:
outputsmap from strings to objects

出力ポートIDをキーとする実行の出力。各出力は、ポートのcontent_schemaのtypeに基づいてtypeで識別されるTemplateOutputです。

エラー

422
Unprocessable Entity Error