Skip to main content
POST
Render a Video by id

Per-Render Callback URL

You can optionally pass a callbackUrl in the request body to receive a one-shot notification when this specific render completes.
The events you will receive on this callback are VIDEO_GENERATION_SUCCESS or VIDEO_GENERATION_FAILED. Both include renderCost and renderCostRefunded. The 200 response is the video plus renderCost, the credits debited for this render. Quote that number first with GET /videos//estimate. When the balance is too low the render does not start, and the 402 body includes renderCost and currentBalance.
The callbackUrl must use HTTPS.

Authorizations

x-api-key
string
header
required

API key to be included in the x-api-key header

Path Parameters

id
string
required

The id of the Video to render

Body

application/json
callbackUrl
string<uri>

Optional HTTPS URL to receive a one-shot webhook notification when this specific render completes (success or fail). The callback is fired once and then discarded. Both this callback and workspace webhooks include renderCost (credits debited for this render) and renderCostRefunded (true when that debit was refunded, which is the usual case when the render fails).

Example:

"https://example.com/hooks/argil-render"

Response

The video plus the credits debited for this render

renderCost
integer
required

Credits debited for this render. 0 when the bundle was free. Absent from GET /videos and GET /videos/{id}.

Required range: x >= 0
id
string<uuid>
name
string
createdAt
string<date-time>
updatedAt
string<date-time>
status
string

Can be either IDLE, GENERATING_AUDIO, GENERATING_VIDEO, DONE or FAILED.

duration
number | null

Total video duration in seconds. null when audio hasn't been generated yet.

moments
object[]

An array of Moment items, each representing a portion of the complete video.

videoUrl
string

The url of the final avatar rendering video, containing all the moments merged.

videoUrlSubtitled
string

The url of the final avatar rendering video with subtitles. Only available if subtitles are enabled.

previewUrl
string

Url to the embedable preview of the video. Can be watched from web browsers or integrated in other websites before launching the generation. For embedable mode, add ?embed=true to the url.

aspectRatio
enum<string>

The aspect ratio of the video output: 16:9 or 9:16.

Available options:
16:9,
9:16
subtitles
object

Subtitles settings for the video

extras
object

A dictionary of custom key-value pairs to extend the video metadata. Maximum of 5 key-value pairs of 256 characters allowed.