ElevenCreativeImage & VideoFlowsTemplatesRuns

Criar execução de modelo

Inicia uma execução de um modelo de flows. Informe `version_id` para fixar um snapshot ou omita-o / informe `latest` para executar a versão publicada mais recente. Defina os valores de entrada em `inputs`, usando o ID da porta de entrada como chave. A resposta é a execução em seu estado inicial, com cada saída já listada em `outputs` sob o ID da respectiva porta. Inclua `webhook` para receber um evento `flows_template_run` com a execução concluída assim que seu `status` for `completed` ou `failed`; essa é a forma recomendada de aguardar. Sem isso, consulte `GET /v1/flows/templates/{template_id}/runs/{run_id}` em intervalos moderados até que o `status` seja terminal.

Parâmetros de caminho

template_idstringObrigatório

O ID do modelo, conforme exibido no app da ElevenLabs ou por GET /v1/flows/templates.

Cabeçalhos

xi-api-keystringOpcional

Solicitação

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

Valores de entrada indexados pelo ID da porta de entrada. Todas as portas de entrada da versão em execução devem ser informadas; um ID ausente ou desconhecido será rejeitado. Passe {} para um template sem entradas.

version_idstring or nullOpcional>=1 character

O snapshot do modelo a ser executado. Passe um ID de versão específico para fixar esse snapshot ou latest (o padrão quando omitido) para executar a versão publicada mais recentemente do modelo. Apenas versões publicadas podem ser fixadas, exceto pelo proprietário do modelo, que também pode fixar um snapshot salvo e não publicado para testá-lo antes da publicação. O rascunho ativo nunca é executado por esta API.

webhookobject or nullOpcional

Inclua para enviar o resultado da execução aos webhooks de fluxos configurados no workspace quando o status da execução atingir completed ou failed. Há um evento para toda a execução: os data do evento flows_template_run correspondem à resposta final de GET /v1/flows/templates/{template_id}/runs/{run_id}.

Resposta

Resposta bem-sucedida

idstring

O identificador exclusivo da execução.

template_idstring

O modelo executado por esta execução, para que um consumidor de webhook que executa vários modelos possa diferenciar suas execuções sem manter um mapeamento entre execuções e modelos.

version_idstring

A versão do modelo executada por esta execução. Ela é definida quando a execução é criada; portanto, uma execução iniciada com latest registra a versão específica executada.

statusenum

O status da execução, consolidado a partir de suas saídas: pending até uma saída iniciar, generating enquanto alguma saída estiver inacabada, completed quando todas as saídas forem concluídas e failed quando todas as saídas terminarem e pelo menos uma falhar. completed e failed são terminais: o webhook flows_template_run é acionado quando a execução atinge um deles.

Valores permitidos:
outputsmap from strings to objects

As saídas da execução, indexadas pelo ID da porta de saída. Cada uma é um TemplateOutput discriminado por type, o type do content_schema de sua porta.

Erros

422
Unprocessable Entity Error