ElevenCreative이미지 & 비디오FlowsTemplatesRuns

템플릿 실행 생성

flows 템플릿 실행을 시작합니다. 스냅샷을 고정하려면 `version_id`를 전달하고, 최신 게시 버전을 실행하려면 생략하거나 `latest`를 전달하세요. 입력 포트 ID를 키로 사용해 `inputs` 아래에 입력 값을 설정합니다. 응답은 초기 상태의 실행이며, 모든 출력은 이미 `outputs` 아래의 포트 ID별로 나열됩니다. `status`가 `completed` 또는 `failed`가 되면 완료된 실행을 포함하는 `flows_template_run` 이벤트를 받도록 `webhook`을 포함하세요. 이는 권장되는 대기 방식입니다. 웹훅이 없으면 `status`가 종료 상태가 될 때까지 적절한 간격으로 `GET /v1/flows/templates/{template_id}/runs/{run_id}`를 조회하세요.

경로 매개변수

template_idstring필수

ElevenLabs 앱 또는 GET /v1/flows/templates에 표시되는 템플릿의 ID입니다.

헤더

xi-api-keystring선택 사항

요청

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

입력 포트 ID를 키로 하는 입력값입니다. 실행 중인 버전의 모든 입력 포트를 제공해야 하며, 누락되었거나 알 수 없는 ID는 거부됩니다. 입력이 없는 템플릿에는 {}를 전달하세요.

version_idstring or null선택 사항>=1 character

실행할 템플릿 스냅샷입니다. 특정 버전 ID를 전달하여 해당 스냅샷을 고정하거나, latest(생략 시 기본값)를 전달하여 템플릿의 가장 최근 게시 버전을 실행하세요. 게시된 버전만 고정할 수 있지만, 템플릿 소유자는 게시 전에 테스트하기 위해 게시되지 않은 저장 스냅샷도 고정할 수 있습니다. 라이브 초안은 이 API를 통해 실행되지 않습니다.

webhookobject or null선택 사항

실행의 status가 completed 또는 failed에 도달하면 결과를 워크스페이스에 구성된 flows 웹훅으로 전송하려면 포함하세요. 전체 실행에 대해 하나의 이벤트가 발생하며, flows_template_run 이벤트의 data는 GET /v1/flows/templates/{template_id}/runs/{run_id}의 최종 응답과 일치합니다.

응답

성공 응답

idstring

실행의 고유 식별자입니다.

template_idstring

이 실행에서 사용된 템플릿입니다. 여러 템플릿을 실행하는 웹훅 소비자가 실행-템플릿 매핑을 유지하지 않고도 각 실행을 구분할 수 있습니다.

version_idstring

이 실행에서 사용된 템플릿 버전입니다. 실행이 생성될 때 확인되므로, latest로 시작한 실행은 실제로 실행된 구체적인 버전을 기록합니다.

statusenum

출력에서 집계된 실행 상태입니다. 출력이 시작될 때까지는 pending, 하나라도 완료되지 않은 출력이 있으면 generating, 모든 출력이 완료되면 completed, 모든 출력이 종료되고 하나 이상 실패하면 failed입니다. completed 및 failed는 종료 상태이며, 실행이 둘 중 하나에 도달하면 flows_template_run 웹훅이 실행됩니다.

허용된 값:
outputsmap from strings to objects

출력 포트 ID를 키로 하는 실행 결과입니다. 각 결과는 해당 포트 content_schema의 type인 type으로 구분되는 TemplateOutput입니다.

오류

422
Unprocessable Entity Error