List Assets

Headers

Authorization

string | null

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings. Example: 'Bearer sk_1234567890abcdef'

X-Namespace

string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Query Parameters

page

integer | null

default:

page_size

integer

default:

Body

application/json

collections

string[]

required

List of Collection IDs or Names to search within, required

filters

object | null

Used for filtering across all indexes

filters.AND

object[] | null

Logical AND operation

filters.AND.AND

object[] | null

Logical AND operation

filters.AND.case_sensitive

boolean | null

default:

false

Whether to perform case-sensitive matching

filters.AND.NOR

object[] | null

Logical NOR operation

filters.AND.OR

object[] | null

Logical OR operation

filters.case_sensitive

boolean | null

default:

false

Whether to perform case-sensitive matching

filters.NOR

object[] | null

Logical NOR operation

filters.NOR.AND

object[] | null

Logical AND operation

filters.NOR.case_sensitive

boolean | null

default:

false

Whether to perform case-sensitive matching

filters.NOR.NOR

object[] | null

Logical NOR operation

filters.NOR.OR

object[] | null

Logical OR operation

filters.OR

object[] | null

Logical OR operation

filters.OR.AND

object[] | null

Logical AND operation

filters.OR.case_sensitive

boolean | null

default:

false

Whether to perform case-sensitive matching

filters.OR.NOR

object[] | null

Logical NOR operation

filters.OR.OR

object[] | null

Logical OR operation

group_by

object | null

Grouping options for search results

group_by.field

string | null

default:

asset_id

    Field to group by
    
    Note: We currently do not support ad-hoc grouping.
    This means the field must be indexed separately. 
    Please contact us to add additional fields for grouping.

group_by.max_assets

integer | null

default:

Maximum number of assets to group

group_by.sort

object | null

Sort options for ordering the inside of the groups

return_url

boolean | null

default:

false

Return the presigned URL for the asset and preview asset, this will introduce additional latency

select

string[] | null

List of fields to return in results, supports dot notation. If None, all fields are returned.

sort

object | null

List of fields to sort by, with direction (asc or desc). Supports dot notation for nested fields.

Response

200 - application/json

pagination

object

required

results

object[]

required

Health

Features

Ingest Assets

Entities

Assets

Collections

Namespaces

Feature Extractors

Tasks

Headers

Query Parameters

Body

Response