Skip to navigation
ElevenCreativeAfbeelding & VideoFlowsTemplatesRuns

Templatesessie maken

Start een uitvoering van een flows-sjabloon. Geef version_id door om een snapshot vast te zetten, of laat het weg / geef latest door om de meest recente gepubliceerde versie uit te voeren. Stel invoerwaarden in onder inputs, met de id van de invoerpoort als sleutel. De response is de uitvoering in de beginstatus, waarbij elke uitvoer al onder de poort-id in outputs staat vermeld. Voeg webhook toe om een flows_template_run-event te ontvangen met de voltooide uitvoering zodra de status completed of failed is; dit is de aanbevolen manier om te wachten. Zonder webhook haal je GET /v1/flows/templates/{template_id}/runs/{run_id} met een bescheiden interval op totdat de status definitief is.

Path parameters

template_idstringRequired

De ID van de template, zoals weergegeven in de ElevenLabs-app of door GET /v1/flows/templates.

Headers

xi-api-keystringOptional

Request

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

Invoerwaarden, ingedeeld op inputpoort-id. Voor elke inputpoort van de uitgevoerde versie moet een waarde worden opgegeven; een ontbrekende of onbekende id wordt afgewezen. Geef {} door voor een template zonder invoer.

version_idstring or nullOptional>=1 character

De templatesnapshot die moet worden uitgevoerd. Geef een specifieke versie-ID op om die snapshot vast te zetten, of latest (de standaardwaarde wanneer deze wordt weggelaten) om de meest recent gepubliceerde versie van de template uit te voeren. Alleen gepubliceerde versies kunnen worden vastgezet, behalve door de eigenaar van de template, die ook een niet-gepubliceerde opgeslagen snapshot kan vastzetten om deze vóór publicatie uit te proberen. Het liveconcept wordt nooit via deze API uitgevoerd.

webhookobject or nullOptional

Voeg dit toe om het resultaat van de run naar de geconfigureerde flows-webhooks van de workspace te sturen zodra de status van de run completed of failed bereikt. Eén event voor de hele run: de data van het event flows_template_run komt overeen met het eindantwoord van GET /v1/flows/templates/{template_id}/runs/{run_id}.

Response

Geslaagde response
idstring
De unieke identificatiecode van de run.
template_idstring
De template die deze uitvoering heeft uitgevoerd, zodat een webhookconsumer die meerdere templates uitvoert de uitvoeringen kan onderscheiden zonder een koppeling tussen uitvoeringen en templates bij te houden.
version_idstring

De templateversie die deze run heeft uitgevoerd. Deze wordt bepaald wanneer de run wordt gemaakt, zodat een run die met latest is gestart, de concrete versie vastlegt die is uitgevoerd.

statusenum

De status van de run, samengevoegd uit de uitvoer: pending totdat een uitvoer start, generating zolang een uitvoer niet is voltooid, completed zodra alle uitvoer is voltooid en failed zodra alle uitvoer is voltooid en ten minste één is mislukt. completed en failed zijn eindstatussen: de webhook flows_template_run wordt geactiveerd zodra de run een van beide bereikt.

Allowed values:
outputsmap from strings to objects

De uitvoer van de run, ingedeeld op uitvoerpoort-id. Elk item is een TemplateOutput, onderscheiden op type, het type van de content_schema van de poort.

Errors

422
Unprocessable Entity Error