List Collection Assets

POST

collections

{collection_id}

assets

curl --request POST \
  --url https://api.aspect.inc/collections/{collection_id}/assets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "values": [
        "<unknown>"
      ]
    }
  ],
  "sorts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order": "asc"
    }
  ]
}
'

import requests

url = "https://api.aspect.inc/collections/{collection_id}/assets"

payload = {
    "filters": [
        {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "values": ["<unknown>"]
        }
    ],
    "sorts": [
        {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "order": "asc"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    filters: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', values: ['<unknown>']}],
    sorts: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', order: 'asc'}]
  })
};

fetch('https://api.aspect.inc/collections/{collection_id}/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.aspect.inc/collections/{collection_id}/assets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'filters' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'values' => [
                                '<unknown>'
                ]
        ]
    ],
    'sorts' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'order' => 'asc'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aspect.inc/collections/{collection_id}/assets"

	payload := strings.NewReader("{\n  \"filters\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"values\": [\n        \"<unknown>\"\n      ]\n    }\n  ],\n  \"sorts\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"order\": \"asc\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aspect.inc/collections/{collection_id}/assets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"values\": [\n        \"<unknown>\"\n      ]\n    }\n  ],\n  \"sorts\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"order\": \"asc\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aspect.inc/collections/{collection_id}/assets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"values\": [\n        \"<unknown>\"\n      ]\n    }\n  ],\n  \"sorts\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"order\": \"asc\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "video",
    "name": "<string>",
    "size_bytes": 123,
    "mime_type": "<string>",
    "save_original": true,
    "is_uploaded": true,
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "comment_count": 123,
    "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "is_symlink": false,
    "target_path": [
      "<string>"
    ],
    "target_path_type": "relative",
    "target_resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "target_resource_name": "<string>",
    "target_resource_type": "workspace",
    "target_resolution_status": "resolved",
    "duration": 123,
    "page_count": 123,
    "path": [
      "<string>"
    ],
    "features": {},
    "actions": 123,
    "stream_proxy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "url_expires_at": "2023-11-07T05:31:56Z",
      "playback_mode": "mp4",
      "size_bytes": 123
    },
    "scrub_proxy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "url_expires_at": "2023-11-07T05:31:56Z",
      "playback_mode": "mp4",
      "size_bytes": 123
    },
    "audio_proxy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "url_expires_at": "2023-11-07T05:31:56Z",
      "playback_mode": "mp4",
      "size_bytes": 123
    },
    "doc_proxy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "url_expires_at": "2023-11-07T05:31:56Z",
      "playback_mode": "mp4",
      "size_bytes": 123
    },
    "scrub_preview": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "url_expires_at": "2023-11-07T05:31:56Z",
      "scrub_metadata": {
        "frame_count": 123,
        "width": 123,
        "height": 123,
        "frames_x": 123,
        "frames_y": 123,
        "frame_width": 123,
        "frame_height": 123
      }
    },
    "preview": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "url_expires_at": "2023-11-07T05:31:56Z",
      "scrub_metadata": {
        "frame_count": 123,
        "width": 123,
        "height": 123,
        "frames_x": 123,
        "frames_y": 123,
        "frame_width": 123,
        "frame_height": 123
      }
    },
    "created_by_user": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "avatar_url": "<string>"
    },
    "client_performed_at": "2023-11-07T05:31:56Z",
    "version_stack_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "is_top_version": true,
    "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_latest": true
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

JWT in Authorization header. 'Bearer ' prefix optional.

Path Parameters

collection_id

string<uuid>

required

Body

application/json

API request for filtered collection asset list refs.

filters

Filter · object[] | null

List of filter objects

Show child attributes

sorts

Sort · object[] | null

List of sorts applied in order

Maximum array length: 3

Show child attributes

Response

Successful Response

string<uuid>

required

type

enum<string>

required

Type of the asset (video, image, etc)

Available options:

video,

image,

audio,

document,

vector,

other

name

string

required

size_bytes

integer

required

mime_type

string

required

save_original

boolean

required

is_uploaded

boolean

required

user_id

string<uuid>

required

workspace_id

string<uuid>

required

ID of the workspace this asset belongs to

project_id

string<uuid>

required

ID of the project this asset belongs to

parent_id

string<uuid>

required

ID of the parent resource (directory or project)

comment_count

integer

required

Total number of visible comments on this asset, including replies

created_by_user_id

string<uuid>

required

ID of the user that created the asset

created

string<date-time>

required

updated

string<date-time>

required

is_symlink

boolean

default:false

True when this item is a projected symlink

target_path

string[] | null

Symlink target path components

target_path_type

enum<string> | null

Symlink target path type

Available options:

relative,

internal_absolute,

external_absolute

target_resource_id

string<uuid> | null

Resolved target resource ID

target_resource_name

string | null

Resolved target resource name

target_resource_type

enum<string> | null

Resolved or hinted target resource type

Available options:

workspace,

project,

directory,

asset,

symlink,

collection

target_resolution_status

enum<string> | null

Symlink resolution status

Available options:

resolved,

dangling,

permission_denied,

external

duration

number | null

Duration in seconds for time-based assets. NULL for non-time-based assets.

page_count

integer | null

Number of pages for document assets. NULL for non-document assets.

path

string[] | null

Original file path for the asset (e.g., ['path', 'to', 'file.mov'])

features

FeatureStateMapResponse · object | null

Admin-only feature state diagnostics for this asset

Show child attributes

actions

integer | null

stream_proxy

ProxyDeliveryGetResponse · object

API response schema for in-app proxy playback URLs.

ProxyDeliveryGetResponse
ProxyGetResponse

Show child attributes

scrub_proxy

ProxyDeliveryGetResponse · object

API response schema for in-app proxy playback URLs.

ProxyDeliveryGetResponse
ProxyGetResponse

Show child attributes

audio_proxy

ProxyDeliveryGetResponse · object

API response schema for in-app proxy playback URLs.

ProxyDeliveryGetResponse
ProxyGetResponse

Show child attributes

doc_proxy

ProxyDeliveryGetResponse · object

API response schema for in-app proxy playback URLs.

ProxyDeliveryGetResponse
ProxyGetResponse

Show child attributes

scrub_preview

PreviewDeliveryGetResponse · object

API response schema for in-app preview rendering URLs.

PreviewDeliveryGetResponse
PreviewGetResponse

Show child attributes

preview

PreviewDeliveryGetResponse · object

API response schema for in-app preview rendering URLs.

PreviewDeliveryGetResponse
PreviewGetResponse

Show child attributes

created_by_user

UserInfo · object | null

User who created this asset

Show child attributes

client_performed_at

string<date-time> | null

Server-recorded timestamp of the latest user action on this asset, flattened from the asset's current revision. NULL when no revision exists. Used by the desktop renderer to compare against a per-pin coverage cursor.

version_stack_id

string<uuid> | null

Version stack ID. NULL if not in a stack.

version_number

integer | null

1-indexed position in version stack. NULL if not in a stack.

is_top_version

boolean | null

TRUE for top version in stack. NULL if not in a stack.

revision_id

string<uuid> | null

ID of the revision created by this operation (set on rename/move)

is_latest

boolean | null

Whether the revision is the overall latest (set on rename/move)

List Collection Assets

curl --request POST \
  --url https://api.aspect.inc/collections/{collection_id}/assets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "values": [
        "<unknown>"
      ]
    }
  ],
  "sorts": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order": "asc"
    }
  ]
}
'

import requests

url = "https://api.aspect.inc/collections/{collection_id}/assets"

payload = {
    "filters": [
        {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "values": ["<unknown>"]
        }
    ],
    "sorts": [
        {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "order": "asc"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    filters: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', values: ['<unknown>']}],
    sorts: [{id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', order: 'asc'}]
  })
};

fetch('https://api.aspect.inc/collections/{collection_id}/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.aspect.inc/collections/{collection_id}/assets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'filters' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'values' => [
                                '<unknown>'
                ]
        ]
    ],
    'sorts' => [
        [
                'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'order' => 'asc'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aspect.inc/collections/{collection_id}/assets"

	payload := strings.NewReader("{\n  \"filters\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"values\": [\n        \"<unknown>\"\n      ]\n    }\n  ],\n  \"sorts\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"order\": \"asc\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.aspect.inc/collections/{collection_id}/assets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"values\": [\n        \"<unknown>\"\n      ]\n    }\n  ],\n  \"sorts\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"order\": \"asc\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aspect.inc/collections/{collection_id}/assets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"values\": [\n        \"<unknown>\"\n      ]\n    }\n  ],\n  \"sorts\": [\n    {\n      \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"order\": \"asc\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "video",
    "name": "<string>",
    "size_bytes": 123,
    "mime_type": "<string>",
    "save_original": true,
    "is_uploaded": true,
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "comment_count": 123,
    "created_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "is_symlink": false,
    "target_path": [
      "<string>"
    ],
    "target_path_type": "relative",
    "target_resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "target_resource_name": "<string>",
    "target_resource_type": "workspace",
    "target_resolution_status": "resolved",
    "duration": 123,
    "page_count": 123,
    "path": [
      "<string>"
    ],
    "features": {},
    "actions": 123,
    "stream_proxy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "url_expires_at": "2023-11-07T05:31:56Z",
      "playback_mode": "mp4",
      "size_bytes": 123
    },
    "scrub_proxy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "url_expires_at": "2023-11-07T05:31:56Z",
      "playback_mode": "mp4",
      "size_bytes": 123
    },
    "audio_proxy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "url_expires_at": "2023-11-07T05:31:56Z",
      "playback_mode": "mp4",
      "size_bytes": 123
    },
    "doc_proxy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "url_expires_at": "2023-11-07T05:31:56Z",
      "playback_mode": "mp4",
      "size_bytes": 123
    },
    "scrub_preview": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "url_expires_at": "2023-11-07T05:31:56Z",
      "scrub_metadata": {
        "frame_count": 123,
        "width": 123,
        "height": 123,
        "frames_x": 123,
        "frames_y": 123,
        "frame_width": 123,
        "frame_height": 123
      }
    },
    "preview": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "url": "<string>",
      "url_expires_at": "2023-11-07T05:31:56Z",
      "scrub_metadata": {
        "frame_count": 123,
        "width": 123,
        "height": 123,
        "frames_x": 123,
        "frames_y": 123,
        "frame_width": 123,
        "frame_height": 123
      }
    },
    "created_by_user": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "avatar_url": "<string>"
    },
    "client_performed_at": "2023-11-07T05:31:56Z",
    "version_stack_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "version_number": 123,
    "is_top_version": true,
    "revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_latest": true
  }
]

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Overview

API Endpoints

List Collection Assets

Authorizations

Path Parameters

Body

Response