POST
/
videos
curl --request POST \
  --url https://api.argil.ai/v1/videos \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "moments": [
    {
      "transcript": "<string>",
      "avatarId": "<string>",
      "voiceId": "<string>",
      "gestureSlug": "<string>",
      "audioUrl": "<string>",
      "zoom": {
        "level": 1
      }
    }
  ],
  "subtitles": {
    "enable": true
  },
  "aspectRatio": "16:9",
  "enableAutoBrolls": true,
  "autoBrolls": {
    "enable": true,
    "source": "GENERATION",
    "intensity": "LOW"
  },
  "extras": {},
  "backgroundMusic": {
    "assetId": "<string>",
    "volume": 0.5
  }
}'
{
  "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>"
    }
  ],
  "videoUrl": "<string>",
  "videoUrlSubtitled": "<string>",
  "subtitles": {
    "enable": true
  },
  "extras": {}
}

Authorizations

​
x-api-key
string
header
required

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

Body

application/json
​
name
string
required
​
moments
object[]
required

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

​
subtitles
object

Subtitles settings for the video

​
aspectRatio
enum<string>

Select desired output aspectRatio: 16:9 or 9:16. Optional, default depends on used avatar.

Available options:
16:9,
9:16
​
enableAutoBrolls
boolean

[DEPRECATED] Enable automatic B-roll generation and placement. When enabled, the system will analyze your content and automatically add relevant B-rolls to appropriate moments.

​
autoBrolls
object

Configuration for automatic B-roll generation and placement.

​
extras
object

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

​
backgroundMusic
object

Optional configuration for background music

Response

201
application/json
Successfully created Video
​
id
string
​
name
string
​
createdAt
string
​
updatedAt
string
​
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.

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

Was this page helpful?

Suggest editsRaise issue
/videos/videos/{id}