ElevenCreativeImage & VideoFlowsTemplatesRuns

Vorlagenausführung erstellen

Starten Sie einen Durchlauf einer Flows-Vorlage. Übergeben Sie `version_id`, um einen Snapshot festzulegen, oder lassen Sie ihn weg bzw. übergeben Sie `latest`, um die zuletzt veröffentlichte Version auszuführen. Legen Sie Eingabewerte unter `inputs` fest, mit der ID des Eingabeports als Schlüssel. Die Antwort ist der Durchlauf im Anfangszustand; jede Ausgabe ist bereits unter ihrer Port-ID in `outputs` aufgeführt. Fügen Sie `webhook` ein, um ein `flows_template_run`-Ereignis mit dem abgeschlossenen Durchlauf zu erhalten, sobald dessen `status` `completed` oder `failed` lautet; dies ist die empfohlene Warteweise. Ohne Webhook rufen Sie `GET /v1/flows/templates/{template_id}/runs/{run_id}` in angemessenen Abständen ab, bis der `status` endgültig ist.

Pfadparameter

template_idstringErforderlich

Die ID der Vorlage, wie sie in der ElevenLabs-App oder über GET /v1/flows/templates angezeigt wird.

Header

xi-api-keystringOptional

Anfrage

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

Eingabewerte, aufgeschlüsselt nach Eingabeport-ID. Jeder Eingabeport der ausgeführten Version muss angegeben werden; eine fehlende oder unbekannte ID wird abgelehnt. Übergeben Sie {} für eine Vorlage ohne Eingaben.

version_idstring or nullOptional>=1 character

Der auszuführende Template-Snapshot. Übergeben Sie eine bestimmte Versions-ID, um diesen Snapshot festzulegen, oder latest (der Standardwert, wenn nicht angegeben), um die zuletzt veröffentlichte Version des Templates auszuführen. Nur veröffentlichte Versionen können festgelegt werden. Der Eigentümer des Templates kann jedoch auch einen unveröffentlichten gespeicherten Snapshot festlegen, um ihn vor der Veröffentlichung zu testen. Der Live-Entwurf wird niemals über diese API ausgeführt.

webhookobject or nullOptional

Fügen Sie dies ein, um das Ergebnis des Runs an die konfigurierten Flows-Webhooks des Workspace zu senden, sobald der status des Runs completed oder failed erreicht. Ein Ereignis für den gesamten Run: Die data des Ereignisses flows_template_run entsprechen der finalen Antwort von GET /v1/flows/templates/{template_id}/runs/{run_id}.

Antwort

Erfolgreiche Antwort
idstring
Die eindeutige Kennung des Durchlaufs.
template_idstring

Das Template, das bei diesem Durchlauf ausgeführt wurde. So kann ein Webhook-Consumer mit mehreren Templates deren Durchläufe unterscheiden, ohne eine Zuordnung von Durchläufen zu Templates zu speichern.

version_idstring

Die Template-Version, die bei diesem Durchlauf ausgeführt wurde. Sie wird beim Erstellen des Durchlaufs aufgelöst. Daher speichert ein mit latest gestarteter Durchlauf die konkrete ausgeführte Version.

statusenum

Der aus seinen Ausgaben zusammengefasste Status des Runs: pending, bis eine Ausgabe startet; generating, solange eine Ausgabe nicht abgeschlossen ist; completed, sobald alle Ausgaben abgeschlossen sind; und failed, sobald alle Ausgaben abgeschlossen sind und mindestens eine fehlgeschlagen ist. completed und failed sind Endzustände: Der Webhook flows_template_run wird ausgelöst, sobald der Run einen dieser Zustände erreicht.

Erlaubte Werte:
outputsmap from strings to objects

Die Ausgaben des Runs, gruppiert nach Ausgabe-Port-ID. Jede Ausgabe ist ein TemplateOutput, unterschieden nach type, dem type des content_schema ihres Ports.

Fehler

422
Unprocessable Entity Error