Utwórz uruchomienie szablonu

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"
    }
  }
}

Uruchamia wykonanie szablonu flows. Przekaż version_id, aby przypiąć migawkę, lub pomiń go / przekaż latest, aby uruchomić najnowszą opublikowaną wersję. Ustaw wartości wejściowe w inputs, używając identyfikatora portu wejściowego jako klucza. Odpowiedź zawiera wykonanie w stanie początkowym, a każde wyjście jest już wymienione pod identyfikatorem swojego portu w outputs. Dodaj webhook, aby otrzymać zdarzenie flows_template_run z ukończonym wykonaniem, gdy jego status będzie równy completed lub failed; to zalecany sposób oczekiwania. Bez niego pobieraj GET /v1/flows/templates/{template_id}/runs/{run_id} w rozsądnych odstępach, aż status osiągnie stan końcowy.

Parametry ścieżki

template_idstringWymagany

ID szablonu, wyświetlane w aplikacji ElevenLabs lub przez GET /v1/flows/templates.

Żądanie

This endpoint expects an object.

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

Wartości wejściowe przypisane do identyfikatora portu wejściowego. Należy podać każdy port wejściowy uruchamianej wersji; brakujący lub nieznany identyfikator zostanie odrzucony. Przekaż {} dla szablonu bez danych wejściowych.

version_idstring or nullOpcjonalny>=1 character

Migawka szablonu do uruchomienia. Przekaż identyfikator konkretnej wersji, aby przypiąć tę migawkę, lub latest (wartość domyślna, gdy parametr pominięto), aby uruchomić ostatnio opublikowaną wersję szablonu. Można przypinać tylko opublikowane wersje, z wyjątkiem właściciela szablonu, który może też przypiąć nieopublikowaną zapisaną migawkę, aby wypróbować ją przed publikacją. Aktywny szkic nigdy nie jest uruchamiany przez to API.

webhookobject or nullOpcjonalny

Uwzględnij, aby wysłać wynik uruchomienia do skonfigurowanych webhooków flows workspace, gdy status uruchomienia osiągnie wartość completed lub failed. Jedno zdarzenie dla całego uruchomienia: data zdarzenia flows_template_run odpowiada końcowej odpowiedzi GET /v1/flows/templates/{template_id}/runs/{run_id}.

Odpowiedź

Pomyślna odpowiedź

idstring

Unikalny identyfikator uruchomienia.

template_idstring

Szablon wykonany przez to uruchomienie, dzięki czemu odbiorca webhooka uruchamiający kilka szablonów może odróżnić ich uruchomienia bez przechowywania mapy uruchomień i szablonów.

version_idstring

Wersja szablonu wykonana przez to uruchomienie. Jest określana podczas tworzenia uruchomienia, więc uruchomienie rozpoczęte z latest zapisuje konkretną wykonaną wersję.

statusenum

Status uruchomienia, zebrany z jego danych wyjściowych: pending, dopóki nie rozpocznie się generowanie danych wyjściowych; generating, gdy dowolne dane wyjściowe są nieukończone; completed, gdy wszystkie dane wyjściowe są ukończone; oraz failed, gdy wszystkie dane wyjściowe się zakończyły, a co najmniej jedno nie powiodło się. completed i failed są stanami końcowymi: webhook flows_template_run jest wywoływany, gdy uruchomienie osiągnie którykolwiek z nich.

Dozwolone wartości:

outputsmap from strings to objects

Dane wyjściowe uruchomienia, indeksowane według ID portu wyjściowego. Każda wartość to TemplateOutput rozróżniany na podstawie type, czyli type pola content_schema jego portu.

Błędy

422

Unprocessable Entity Error

Parametry ścieżki

Nagłówki

Żądanie

Odpowiedź

Błędy