ARargildotai

Get a Video by id

Changed on

Returns a single Video identified by its id

get/videos/{id}

Request

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

Path parameters

idstring required

The id of the Video to retrieve

Response

Detailed information about the 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