Hoppa till navigering
ElevenCreativeBild och videoFlowsTemplatesRuns

Skapa mallkörning

Starta en körning av en flödesmall. Skicka version_id för att låsa en ögonblicksbild, eller utelämna det / skicka latest för att köra den senast publicerade versionen. Ange indatavärden under inputs, med indataportens id som nyckel. Svaret är körningen i dess ursprungliga tillstånd, där varje utdata redan listas under sitt port-id i outputs. Inkludera webhook för att ta emot en flows_template_run-händelse med den färdiga körningen när dess status är completed eller failed; det här är det rekommenderade sättet att vänta. Utan en webhook hämtar du GET /v1/flows/templates/{template_id}/runs/{run_id} med ett måttligt intervall tills status är slutgiltig.

Sökvägsparametrar

template_idstringObligatorisk

ID:t för mallen, som visas i ElevenLabs-appen eller av GET /v1/flows/templates.

Headers

xi-api-keystringValfri

Förfrågan

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

Indatavärden med indataportens ID som nyckel. Varje indataport i versionen som körs måste anges; ett saknat eller okänt ID avvisas. Ange {} för en mall utan indata.

version_idstring or nullValfri>=1 character

Mallögonblicksbilden som ska köras. Ange ett specifikt versions-id för att låsa den ögonblicksbilden, eller latest (standardvärdet när parametern utelämnas) för att köra mallens senast publicerade version. Endast publicerade versioner kan låsas, utom av mallens ägare, som också kan låsa en opublicerad sparad ögonblicksbild för att prova den före publicering. Det aktiva utkastet körs aldrig via detta API.

webhookobject or nullValfri

Inkludera för att skicka körningens resultat till arbetsytans konfigurerade flows-webhooks när körningens status blir completed eller failed. En händelse för hela körningen: händelsens flows_template_run-data motsvarar det slutliga svaret från GET /v1/flows/templates/{template_id}/runs/{run_id}.

Svar

Lyckat svar
idstring

Den unika identifieraren för körningen.

template_idstring

Mallen som den här körningen körde, så att en webhook-mottagare som kör flera mallar kan skilja sina körningar åt utan att behöva behålla en mappning mellan körningar och mallar.

version_idstring

Mallversionen som den här körningen körde. Bestäms när körningen skapas, så en körning som startas med latest registrerar den konkreta version som kördes.

statusenum

Körningens status, sammanställd från dess utdata: pending tills en utdata startar, generating medan någon utdata är oavslutad, completed när varje utdata har slutförts och failed när varje utdata har avslutats och minst en har misslyckats. completed och failed är slutgiltiga: webhooken flows_template_run utlöses när körningen når något av dessa tillstånd.

Tillåtna värden:
outputsmap from strings to objects

Körningens utdata, indexerade efter utport-id. Varje utdata är en TemplateOutput som särskiljs av type, det type som dess ports content_schema har.

Fel

422
Unprocessable Entity Error