Crear ejecución de plantilla

POST

/v1/flows/templates/:template_id/runs

POST

/v1/flows/templates/:template_id/runs

curl -X POST https://api.elevenlabs.io/v1/flows/templates/template_id/runs \
     -H "Content-Type: application/json" \
     -d '{
  "inputs": {
    "prompt": "a corgi on a surfboard",
    "reference": {
      "asset_id": "5xM2KqOnZyce22SPZ9d4",
      "type": "asset"
    }
  },
  "version_id": "latest",
  "webhook": {
    "type": "all"
  }
}'

{
  "id": "sess_JWr5N6X9ZTqf8jD2LmQb",
  "template_id": "tmpl_abc123",
  "version_id": "ver_01hxyz",
  "status": "generating",
  "outputs": {
    "marketing_title": {
      "type": "string",
      "id": "Kx2mP7Y4WVrg9kE3NnRc",
      "status": "completed",
      "content": "Ride the wave."
    },
    "product_demo": {
      "type": "video",
      "id": "QWr5N6X9ZTqf8jD2La3B",
      "status": "generating"
    },
    "product_still": {
      "type": "image",
      "id": "JWr5N6X9ZTqf8jD2LmQb",
      "status": "completed",
      "content_mime_type": "image/png",
      "content_url": "https://storage.googleapis.com/generations/JWr5N6X9ZTqf8jD2LmQb"
    }
  }
}

Inicia una ejecución de una plantilla de flows. Pasa version_id para fijar una instantánea, u omítelo/pasa latest para ejecutar la última versión publicada. Define los valores de entrada en inputs, indexados por el ID del puerto de entrada. La respuesta es la ejecución en su estado inicial, con cada salida ya incluida bajo su ID de puerto en outputs. Incluye webhook para recibir un evento flows_template_run con la ejecución finalizada cuando su status sea completed o failed; esta es la forma recomendada de esperar. Sin uno, consulta GET /v1/flows/templates/{template_id}/runs/{run_id} a intervalos moderados hasta que el status sea terminal.

Inicia una ejecución de una plantilla de flows. Pasa `version_id` para fijar una instantánea, u omítelo/pasa `latest` para ejecutar la última versión publicada. Define los valores de entrada en `inputs`, indexados por el ID del puerto de entrada. La respuesta es la ejecución en su estado inicial, con cada salida ya incluida bajo su ID de puerto en `outputs`. Incluye `webhook` para recibir un evento `flows_template_run` con la ejecución finalizada cuando su `status` sea `completed` o `failed`; esta es la forma recomendada de esperar. Sin uno, consulta `GET /v1/flows/templates/{template_id}/runs/{run_id}` a intervalos moderados hasta que el `status` sea terminal.

Parámetros de ruta

template_idstringRequerido

El ID de la plantilla, tal como se muestra en la app de ElevenLabs o mediante GET /v1/flows/templates.

Solicitud

This endpoint expects an object.

inputsmap from strings to strings or booleans or integers or doubles or objects or lists of TemplateRunInputRequerido

Valores de entrada identificados mediante el ID del puerto de entrada. Debes proporcionar todos los puertos de entrada de la versión que se ejecuta; se rechaza un ID ausente o desconocido. Pasa {} para una plantilla sin entradas.

version_idstring or nullOpcional>=1 character

La instantánea de plantilla que se va a ejecutar. Proporciona un ID de versión específico para fijar esa instantánea o latest (el valor predeterminado si se omite) para ejecutar la versión publicada más recientemente de la plantilla. Solo se pueden fijar versiones publicadas, excepto el propietario de la plantilla, que también puede fijar una instantánea guardada no publicada para probarla antes de publicarla. El borrador activo nunca se ejecuta mediante esta API.

webhookobject or nullOpcional

Inclúyelo para enviar el resultado de la ejecución a los webhooks de flows configurados en el espacio de trabajo cuando el status de la ejecución alcance completed o failed. Un evento para toda la ejecución: los data del evento flows_template_run coinciden con la respuesta final de GET /v1/flows/templates/{template_id}/runs/{run_id}.

Respuesta

Respuesta correcta.

idstring

El identificador único de la ejecución.

template_idstring

La plantilla que ejecutó esta ejecución, para que un consumidor de webhook que ejecute varias plantillas pueda distinguir sus ejecuciones sin mantener una asignación entre ejecuciones y plantillas.

version_idstring

La versión de la plantilla que ejecutó esta ejecución. Se resuelve al crear la ejecución, por lo que una ejecución iniciada con latest registra la versión concreta que ejecutó.

statusenum

El estado de la ejecución, calculado a partir de sus resultados: pending hasta que se inicie un resultado, generating mientras haya algún resultado sin finalizar, completed cuando todos los resultados se hayan completado y failed cuando todos hayan terminado y al menos uno haya fallado. completed y failed son estados finales: el webhook flows_template_run se activa cuando la ejecución alcanza cualquiera de ellos.

Valores permitidos:

outputsmap from strings to objects

Los resultados de la ejecución, indexados por ID de puerto de salida. Cada uno es un TemplateOutput discriminado por type, el type de content_schema de su puerto.

Errores

422

Unprocessable Entity Error

Parámetros de ruta

Encabezados

Solicitud

Respuesta

Errores