Skip to main content
GET
/
assets
List assets
curl --request GET \
  --url https://api.argil.ai/v1/assets \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "type": "AUDIO",
    "status": "PROCESSING",
    "fileUrl": "<string>",
    "thumbnailUrl": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.argil.ai/llms.txt

Use this file to discover all available pages before exploring further.

Returns an array of assets from your library. Supports filtering by type and status, with pagination via query parameters. Pagination metadata is returned in response headers:
HeaderDescription
X-Total-CountTotal number of assets matching the filters
X-PageCurrent page number
X-Page-SizeNumber of items per page
X-Total-PagesTotal number of pages

​
Asset Types

TypeDescription
AUDIOAudio files for background music (system library)
IMAGEUploaded images for use as B-roll
VIDEOUploaded videos for use as B-roll

​
Examples

# All assets (default: READY status)
GET /assets

# Only video assets
GET /assets?type=VIDEO

# Images and videos, page 2
GET /assets?type=IMAGE&type=VIDEO&page=2&pageSize=10

Authorizations

​
x-api-key
string
header
required

API key to be included in the x-api-key header

Query Parameters

​
type
enum<string>[]

Filter by asset type. Can be specified multiple times (e.g. ?type=VIDEO&type=IMAGE). Omit to return all types.

Available options:
AUDIO,
IMAGE,
VIDEO
​
status
enum<string>
default:READY

Filter by processing status. Default: READY.

Available options:
PROCESSING,
READY,
FAILED
​
page
integer
default:1

Page number

Required range: x >= 1
​
pageSize
integer
default:20

Number of items per page

Required range: 1 <= x <= 100

Response

An array of assets. Pagination metadata is in response headers.

​
id
string<uuid>
​
name
string | null
​
type
enum<string>
Available options:
AUDIO,
IMAGE,
VIDEO
​
status
enum<string>

Processing status. Poll until READY before using as B-roll.

Available options:
PROCESSING,
READY,
FAILED
​
fileUrl
string | null

URL to access the asset. Null while processing.

​
thumbnailUrl
string | null

URL to a thumbnail image. Null while processing.

​
createdAt
string<date-time>