List assets
curl --request GET \
--url https://api.argil.ai/v1/assets \
--header 'x-api-key: <api-key>'import requests
url = "https://api.argil.ai/v1/assets"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.argil.ai/v1/assets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.argil.ai/v1/assets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.argil.ai/v1/assets"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.argil.ai/v1/assets")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.argil.ai/v1/assets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "AUDIO",
"status": "PROCESSING",
"fileUrl": "<string>",
"thumbnailUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
]{
"code": 123,
"message": "<string>"
}Assets
List Assets
Get a list of assets from your library
GET
/
assets
List assets
curl --request GET \
--url https://api.argil.ai/v1/assets \
--header 'x-api-key: <api-key>'import requests
url = "https://api.argil.ai/v1/assets"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.argil.ai/v1/assets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.argil.ai/v1/assets",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.argil.ai/v1/assets"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.argil.ai/v1/assets")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.argil.ai/v1/assets")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "AUDIO",
"status": "PROCESSING",
"fileUrl": "<string>",
"thumbnailUrl": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
]{
"code": 123,
"message": "<string>"
}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:
| Header | Description |
|---|---|
X-Total-Count | Total number of assets matching the filters |
X-Page | Current page number |
X-Page-Size | Number of items per page |
X-Total-Pages | Total number of pages |
Asset Types
| Type | Description |
|---|---|
AUDIO | Audio files for background music (system library) |
IMAGE | Uploaded images for use as B-roll |
VIDEO | Uploaded 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
API key to be included in the x-api-key header
Query Parameters
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 Filter by processing status. Default: READY.
Available options:
PROCESSING, READY, FAILED Page number
Required range:
x >= 1Number of items per page
Required range:
1 <= x <= 100Response
An array of assets. Pagination metadata is in response headers.
Available options:
AUDIO, IMAGE, VIDEO Processing status. Poll until READY before using as B-roll.
Available options:
PROCESSING, READY, FAILED URL to access the asset. Null while processing.
URL to a thumbnail image. Null while processing.
Was this page helpful?