Skip to main content
POST
/
videos
/
{id}
/
render
Render a Video by id
curl --request POST \
  --url https://api.argil.ai/v1/videos/{id}/render \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "callbackUrl": "https://example.com/hooks/argil-render"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "moments": [
    {
      "transcript": "<string>",
      "avatarId": "<string>",
      "voiceId": "<string>",
      "audioUrl": "<string>",
      "videoUrl": "<string>",
      "gestureSlug": "<string>",
      "zoom": {},
      "broll": {
        "zoom": {}
      }
    }
  ],
  "videoUrl": "<string>",
  "videoUrlSubtitled": "<string>",
  "previewUrl": "<string>",
  "aspectRatio": "16:9",
  "subtitles": {
    "enable": true
  },
  "extras": {}
}

​
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. 
{
  "callbackUrl": "https://example.com/hooks/argil-render"
}
The events you will receive on this callback are VIDEO_GENERATION_SUCCESS or VIDEO_GENERATION_FAILED.
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.

Example:

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

Response

Detailed information about the Video

​
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.

​
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.