Generate API

Get Generation

Authentication

x-api-keystring
API Key authentication via header

Path parameters

idstringRequired
A unique identifier for the generation.

Response

Job status retrieved successfully
createdAtdatetime
The date and time the generation was created.
idstring
A unique identifier for the generation.
inputlist of objects
An array of input objects used for generation.
modelenum
The name of the model used for generation.
Allowed values:
statusenum
The status of the generation.
Allowed values:
errorstring
The error message if the generation failed.
error_codestring
The error code if the generation failed.
optionsobject
Options for the generation.
outputDurationdouble
The duration of the output media.
outputUrlstring
The URL of the output media.
segmentslist of objects
The segments of the generation.
segmentOutputUrlstring
The URL of the segment output media.
webhookUrlstring
The URL to the webhook endpoint.

Errors

401
Unauthorized Error
404
Not Found Error
500
Internal Server Error