GET
/
videos
curl --request GET \
  --url https://api.argil.ai/v1/videos \
  --header 'x-api-key: <api-key>'
{
  "totalItems": 123,
  "totalPages": 123,
  "currentPage": 123,
  "itemsPerPage": 123,
  "videos": [
    {
      "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

Query Parameters

​
page
integer
default:1

Page number of the video list

​
limit
integer
default:10

Number of videos per page

​
nameSearchQuery
string

Filter videos by name, case-insensitive substring match.

​
avatarId
string

Filter videos by avatar ID.

​
voiceId
string

Filter videos by voice ID.

​
extrasFilter
string

A JSON string representing filters to apply on the extras JSON field. Must be a valid JSON object as a string, specifying properties and values to match.

Example:

"{\"X_ID\": \"YOUR_CUSTOM_ID\"}"

Response

200
application/json

A paginated list of Videos

The response is of type object.

GET
/
videos
curl --request GET \
  --url https://api.argil.ai/v1/videos \
  --header 'x-api-key: <api-key>'
{
  "totalItems": 123,
  "totalPages": 123,
  "currentPage": 123,
  "itemsPerPage": 123,
  "videos": [
    {
      "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

Query Parameters

​
page
integer
default:1

Page number of the video list

​
limit
integer
default:10

Number of videos per page

​
nameSearchQuery
string

Filter videos by name, case-insensitive substring match.

​
avatarId
string

Filter videos by avatar ID.

​
voiceId
string

Filter videos by voice ID.

​
extrasFilter
string

A JSON string representing filters to apply on the extras JSON field. Must be a valid JSON object as a string, specifying properties and values to match.

Example:

"{\"X_ID\": \"YOUR_CUSTOM_ID\"}"

Response

200
application/json

A paginated list of Videos

The response is of type object.