ARargildotai

Create a new Video

Changed on

Creates a new Video with the specified details

post/videos

Request

  • Base URL
    https://api.argil.ai/v1
  • Auth
    API key in header x-api-key

Request body

namestring required
aspectRatio'16:9' | '9:16'

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

enableAutoBrollsboolean

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

extrasobject

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

model'ARGIL_V1' | 'ARGIL_ATOM'

Model to use for the video generation.

Example request

{
  "moments": [
    {
      "zoom": {
        "keyframes": [
          {
            "time": 0,
            "scale": 1
          },
          {
            "time": 1,
            "scale": 1.5,
            "easing": [
              0.42,
              0,
              0.58,
              1
            ]
          }
        ]
      },
      "broll": {
        "zoom": {
          "keyframes": [
            {
              "time": 0,
              "scale": 1
            },
            {
              "time": 1,
              "scale": 1.5,
              "easing": [
                0.42,
                0,
                0.58,
                1
              ]
            }
          ]
        }
      }
    }
  ]
}

Response

Successfully created Video

idstring uuid
namestring
createdAtstring date-time
updatedAtstring date-time
statusstring

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

durationnumber nullable

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

videoUrlstring

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

videoUrlSubtitledstring

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

previewUrlstring

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'16:9' | '9:16'

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

extrasobject

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

Changes