Create a new Video

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,
    "styleId": "<string>",
    "position": "Top",
    "size": "Small"
  },
  "aspectRatio": "16:9",
  "enableAutoBrolls": true,
  "autoBrolls": {
    "enable": true,
    "source": "GENERATION",
    "intensity": "LOW",
    "layout": "FULLSCREEN"
  },
  "extras": {},
  "backgroundMusic": {
    "assetId": "<string>",
    "volume": 0.5
  },
  "model": "ARGIL_V1"
}
'

{
  "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": {}
}

POST

videos

Create a new Video

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,
    "styleId": "<string>",
    "position": "Top",
    "size": "Small"
  },
  "aspectRatio": "16:9",
  "enableAutoBrolls": true,
  "autoBrolls": {
    "enable": true,
    "source": "GENERATION",
    "intensity": "LOW",
    "layout": "FULLSCREEN"
  },
  "extras": {},
  "backgroundMusic": {
    "assetId": "<string>",
    "volume": 0.5
  },
  "model": "ARGIL_V1"
}
'

{
  "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.

Show child attributes

moments.transcript

string

required

A portion of the complete transcript. Current limit: 250 characters

moments.avatarId

string

required

The id of the avatar to be used for this moment

moments.voiceId

string

The id of the voice to be used for this moment. Optional, default is the avatar's voice.

moments.gestureSlug

string

The slug identifier of the gesture to be used for this moment

moments.audioUrl

string

Optional url to the audio to be used for the video rendering, for bypassing our audio generation model. Current limit: 20 seconds

moments.zoom

object

Controls the zoom level of the viewport/display, allowing content to be scaled larger or smaller

Show child attributes

moments.zoom.level

number

default:1

required

Specifies the zoom scaling factor where 1.0 represents 100% (original size), and 2.0 is 200% (zoomed in)

Required range: 1 <= x <= 2

subtitles

object

Subtitles settings for the video

Show child attributes

subtitles.enable

boolean

required

subtitles.styleId

string

ID of the subtitle style to apply. Styles can be fetched from the /subtitles endpoint.

subtitles.position

enum<string>

Position of subtitles on the video

Available options:

Top,

Middle,

Bottom

subtitles.size

enum<string>

Size of the subtitle text

Available options:

Small,

Medium,

Large

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.

Show child attributes

autoBrolls.enable

boolean

required

Enable or disable automatic B-roll generation.

autoBrolls.source

enum<string>

required

Source for B-rolls: 'GENERATION' for generated images or 'GOOGLE_IMAGES' for images from Google, 'STOCKS_VIDEO' for GettyImages videos or 'AVATAR_ACTION' for generated videos including the avatar (only available with AI Influencer avatars).

Available options:

GENERATION,

GOOGLE_IMAGES,

STOCKS_VIDEO,

AVATAR_ACTION

autoBrolls.intensity

enum<string>

required

Intensity level of B-rolls: 'LOW', 'MEDIUM', or 'HIGH'. Not available for 'AVATAR_ACTION' source.

Available options:

LOW,

MEDIUM,

HIGH

autoBrolls.layout

enum<string>

Layout control for moments containing a B-roll. Controls how the B-rolls appears relative to the avatar.

Available options:

FULLSCREEN,

AVATAR_BOTTOM_LEFT,

AVATAR_BOTTOM_RIGHT,

AVATAR_TOP_LEFT,

AVATAR_TOP_RIGHT,

SPLIT_AVATAR_LEFT,

SPLIT_AVATAR_RIGHT,

SPLIT_AVATAR_TOP,

SPLIT_AVATAR_BOTTOM,

BACKGROUND

extras

object

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

Show child attributes

extras.{key}

string

backgroundMusic

object

Optional configuration for background music

Show child attributes

backgroundMusic.assetId

string

required

ID of an audio asset to use as background music

backgroundMusic.volume

number

Volume level of the background music (0-1). Default is 0.14

Required range: 0 <= x <= 1

model

enum<string>

Model to use for the video generation.

Available options:

ARGIL_V1,

ARGIL_ATOM

Response

Successfully created Video

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.

Show child attributes

moments.transcript

string

A portion of the complete transcript. Current limit: 250 characters.

moments.avatarId

string

The id of the avatar to be used for this moment.

moments.voiceId

string

The id of the voice to be used for this moment.

moments.audioUrl

string

The audio that will be used for the video rendering. Automatically generated from the transcript when not provided. Current limit: 20 seconds.

moments.videoUrl

string

The url of the avatar rendering video for this moment.

moments.gestureSlug

string

The slug identifier of the gesture to be used for this moment.

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

Show child attributes

subtitles.enable

boolean

extras

object

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

Show child attributes

extras.{key}

string

/videos /videos/{id}

⌘I

Avatars

Voices

Videos

Webhooks

Assets

Subtitles

Create a new Video

Authorizations

Body

Response