ElevenCreativeImage & VideoFlowsTemplatesRuns

Créer une exécution de modèle

Lancez une exécution d’un modèle de flux. Transmettez `version_id` pour figer un instantané, ou omettez-le / transmettez `latest` pour exécuter la dernière version publiée. Définissez les valeurs d’entrée sous `inputs`, indexées par l’ID du port d’entrée. La réponse correspond à l’exécution dans son état initial, chaque sortie étant déjà répertoriée sous son ID de port dans `outputs`. Incluez `webhook` pour recevoir un événement `flows_template_run` contenant l’exécution terminée lorsque son `status` est `completed` ou `failed` ; c’est la méthode d’attente recommandée. Sans webhook, récupérez `GET /v1/flows/templates/{template_id}/runs/{run_id}` à intervalles raisonnables jusqu’à ce que le `status` soit terminal.

Paramètres de chemin

template_idstringRequis

L’ID du modèle, tel qu’il apparaît dans l’application ElevenLabs ou via GET /v1/flows/templates.

En-têtes

xi-api-keystringOptionnel

Requête

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

Valeurs d’entrée indexées par ID de port d’entrée. Chaque port d’entrée de la version exécutée doit être fourni ; un ID manquant ou inconnu est rejeté. Transmettez {} pour un modèle sans entrées.

version_idstring or nullOptionnel>=1 character

L’instantané du modèle à exécuter. Fournissez un identifiant de version spécifique pour figer cet instantané, ou latest, la valeur par défaut s’il est omis, pour exécuter la version publiée la plus récente du modèle. Seules les versions publiées peuvent être figées, sauf par le propriétaire du modèle, qui peut également figer un instantané enregistré non publié pour le tester avant publication. Le brouillon actif n’est jamais exécuté via cette API.

webhookobject or nullOptionnel

Incluez ce paramètre pour envoyer le résultat de l’exécution aux webhooks de flux configurés du Workspace lorsque le status de l’exécution atteint completed ou failed. Un événement est envoyé pour l’ensemble de l’exécution : les data de l’événement flows_template_run correspondent à la réponse finale de GET /v1/flows/templates/{template_id}/runs/{run_id}.

Réponse

Réponse réussie

idstring

L’identifiant unique de l’exécution.

template_idstring

Le modèle exécuté par cette exécution, afin qu’un consommateur de webhook exécutant plusieurs modèles puisse distinguer leurs exécutions sans conserver de correspondance entre les exécutions et les modèles.

version_idstring

La version du modèle exécutée par cette exécution. Elle est déterminée lors de la création de l’exécution. Ainsi, une exécution lancée avec latest enregistre la version précise qu’elle a exécutée.

statusenum

L’état de l’exécution, agrégé à partir de ses sorties : pending jusqu’au démarrage d’une sortie, generating tant qu’une sortie n’est pas terminée, completed lorsque toutes les sorties sont terminées, et failed lorsque toutes les sorties sont terminées et qu’au moins une a échoué. completed et failed sont des états terminaux : le webhook flows_template_run est déclenché lorsque l’exécution atteint l’un de ces états.

Valeurs autorisées:
outputsmap from strings to objects

Les sorties de l’exécution, indexées par l’ID du port de sortie. Chacune est un TemplateOutput discriminé selon type, le type du content_schema de son port.

Erreurs

422
Unprocessable Entity Error