For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
SupportStatusTry now
DocumentationAPI Reference
DocumentationAPI Reference
    • API Overview
  • API Guides
    • Authentication
    • Concurrency & Rate Limits
    • Batch Processing
    • Webhooks
  • Generate API
    • POSTCreate Generation
    • POSTCreate Generation with Files
    • GETGet Generation
    • GETList Generations
    • POSTEstimate Cost
  • Batch API
    • POSTCreate Batch
    • GETGet Batch
    • GETList Batches
  • Assets API
    • GETList Assets
    • GETGet Asset
  • Models API
    • GETList Models
  • Webhooks Payload Reference
      • POSTGeneration Status Update
      • POSTBatch Status Update
LogoLogo
SupportStatusTry now
Webhooks Payload ReferenceWebhooks

Generation Status Update

Payload
1{
2  "status": "COMPLETED",
3  "createdAt": "2024-01-10T12:00:00Z",
4  "id": "asdas12312ada",
5  "input": [
6    {
7      "type": "video",
8      "url": "https://example.com/video.mp4"
9    },
10    {
11      "type": "audio",
12      "url": "https://example.com/audio.mp3"
13    }
14  ],
15  "model": "lipsync-2",
16  "error": "",
17  "error_code": "",
18  "options": {},
19  "outputDuration": 10,
20  "outputUrl": "https://example.com/output.mp4",
21  "segmentOutputUrl": "https://example.com/segment_output.mp4",
22  "webhookUrl": "https://example.com/webhook"
23}
Receive a notification when a generation changes status
Was this page helpful?
Previous

Batch Status Update

Next
Built with

Headers

X-Signature-PrimarystringRequired
An HMAC signature of the payload

Payload

The payload of this webhook request is an object.
statusenumRequired
The status of the generation
Allowed values:
createdAtdatetimeRequired
The date and time the generation was created
idstringRequired
A unique identifier for the generation.
inputlist of objectsRequired
The input items for the generation
modelenumRequired
name of the model to use for generation.
Allowed values:
errorstringOptional
error message if the generation failed
error_codestringOptional
error code if the generation failed
optionsobjectOptional
options used for the generation
outputDurationdoubleOptional
generated output media duration in seconds
outputUrlstringOptional
url of the generated output media
segmentOutputUrlstringOptional
url of the segment output media
webhookUrlstringOptional
url of the webhook server

Response

200
any
Return a 200 status to indicate that the data was received successfully.