Ir para a navegação
Webhooks Payload ReferenceWebhooks

generation status update

Sent when a generation reaches a terminal status (COMPLETED, FAILED or REJECTED). Delivery is attempted up to six times over about two hours: timeouts, connection errors, 429 and 5xx responses are retried with backoff (Retry-After is honored), and any other response outside 2xx ends delivery. Each attempt has a 10-second timeout. Every attempt carries the same Sync-Delivery-Id and a freshly timestamped Sync-Signature, so deduplicate on Sync-Delivery-Id or the generation id.

Cabeçalhos

Sync-SignaturestringObrigatório

t=<unix seconds>,v1=<hex HMAC-SHA256>. The HMAC is computed over <t>.<raw request body> with your organization webhook secret from GET /v2/organizations/webhook/secret. Each attempt is signed again with a new timestamp.

Sync-Delivery-IdstringObrigatório
Identifies this delivery. It stays the same on every retry of the same event, so use it to ignore duplicates.

Payload

The payload of this webhook request is an object.
idstringObrigatório
A unique identifier for the generation.
createdAtdatetimeObrigatório
The date and time the generation was created
statusenumObrigatório
The status of the generation
Valores permitidos:
modelenumObrigatório
name of the model to use for generation.
Valores permitidos:
inputlist of objectsObrigatório
The input items for the generation
outputUrlstring or nullObrigatório
url of the generated output media. Null unless the generation completed.
errorstring or nullObrigatório

Human-readable error message if the generation failed or was rejected, otherwise null.

errorCodestring or nullObrigatório

Machine-readable error code if the generation failed or was rejected, otherwise null. See Error Handling and GET /v2/errors.

webhookUrlstringOpcional
url of the webhook server
optionsobjectOpcional
options used for the generation
dubAudioUrlstring or nullOpcional

Dubbed audio URL. Omitted without dubParams; null until the dubbed track is available.

dubAudioAssetIdstring or nullOpcional

Reusable AUDIO asset for the dubbed track. Omitted without dubParams; null until available or when retention settings or a custom output bucket prevent saving it.

synthesizedAudioUrlstringOpcional
url of the speech synthesized from a text input. Present only for generations that used a text input.

Resposta

200
qualquer
Retorne um status 200 para indicar que os dados foram recebidos com sucesso.