GET
/
videos
/
{id}
curl --request GET \
  --url https://api.argil.ai/v1/videos/{id} \
  --header 'x-api-key: <api-key>'
{
  "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

Path Parameters

​
id
string
required

The id of the Video to retrieve

Response

200
application/json
Detailed information about the 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}