Vai alla navigazione

Crea esecuzione del template

Avvia un’esecuzione di un template dei flussi. Passa version_id per fissare uno snapshot oppure omettilo o passa latest per eseguire l’ultima versione pubblicata. Imposta i valori di input in inputs, indicizzati in base all’ID della porta di input. La risposta è l’esecuzione nel suo stato iniziale, con ogni output già elencato in outputs sotto il relativo ID porta. Includi webhook per ricevere un evento flows_template_run contenente l’esecuzione completata quando il suo status è completed o failed; questo è il metodo consigliato per attendere. Senza webhook, recupera GET /v1/flows/templates/{template_id}/runs/{run_id} a intervalli moderati finché il status non è terminale.

Parametri di percorso

template_idstringObbligatorio

L'ID del template, come mostrato nell'app ElevenLabs o da GET /v1/flows/templates.

Header

xi-api-keystringOpzionale

Richiesta

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

Valori di input indicizzati dall'ID della porta di input. Deve essere specificata ogni porta di input della versione in esecuzione; un ID mancante o sconosciuto viene rifiutato. Passa {} per un template senza input.

version_idstring or nullOpzionale>=1 character

Lo snapshot del template da eseguire. Passa un ID versione specifico per fissare quello snapshot, oppure latest (il valore predefinito se omesso) per eseguire la versione pubblicata più di recente del template. Possono essere fissate solo versioni pubblicate, tranne dal proprietario del template, che può fissare anche uno snapshot salvato non pubblicato per provarlo prima della pubblicazione. La bozza live non viene mai eseguita tramite questa API.

webhookobject or nullOpzionale

Includi questa opzione per inviare il risultato dell'esecuzione ai webhook dei flussi configurati nel workspace quando il relativo status raggiunge completed o failed. Un evento per l'intera esecuzione: i data dell'evento flows_template_run corrispondono alla risposta finale di GET /v1/flows/templates/{template_id}/runs/{run_id}.

Risposta

Risposta riuscita
idstring
L'identificatore univoco dell'esecuzione.
template_idstring

Il template eseguito da questa run, così un consumer webhook che esegue più template può distinguere le rispettive run senza mantenere una mappa tra run e template.

version_idstring

La versione del template eseguita da questa run. Viene risolta alla creazione della run, quindi una run avviata con latest registra la versione concreta eseguita.

statusenum

Lo stato dell'esecuzione, aggregato dai relativi output: pending finché non inizia un output, generating mentre un output non è completato, completed quando tutti gli output sono completati e failed quando tutti gli output sono terminati e almeno uno non è riuscito. completed e failed sono stati terminali: il webhook flows_template_run viene attivato quando l'esecuzione raggiunge uno dei due.

Valori consentiti:
outputsmap from strings to objects

Gli output dell'esecuzione, indicizzati in base all'ID della porta di output. Ciascuno è un TemplateOutput discriminato in base a type, il type del relativo content_schema della porta.

Errori

422
Unprocessable Entity Error