Website

Management API

Shopper API

Customers API

Digital Assets Management API

Support

Media

Search Media

Full-text search across images, videos, and files in an app, matching title, alt_text, description, and translations. The response also includes the attribute facets available on the matching media, with distinct-item counts and active flags reflecting attributes= filters. Per-template exclusion: when computing facet counts, filters on the same template_key are ignored while filters on other templates still apply (OR-within-template, AND-across-template).

GET

api

{app_id}

media

Error

A valid request URL is required to generate request examples

{
  "data": [
    {
      "alt_text": "<string>",
      "attributes": [
        {
          "description": "<string>",
          "id": "<string>",
          "key": "<string>",
          "name": "<string>",
          "values": {}
        }
      ],
      "blurhash": "<string>",
      "copyright": "<string>",
      "created_at": "<string>",
      "custom": [
        123
      ],
      "description": "<string>",
      "file_type": "<string>",
      "folder": {
        "id": "<string>",
        "name": "<string>",
        "public": true,
        "slug": "<string>"
      },
      "id": "<string>",
      "status": "<string>",
      "title": "<string>",
      "translations": {},
      "type": "<string>",
      "updated_at": "<string>",
      "url": "<string>",
      "variants": [
        {
          "created_at": "<string>",
          "format": "<string>",
          "height": 123,
          "id": "<string>",
          "updated_at": "<string>",
          "url": "<string>",
          "width": 123
        }
      ]
    }
  ],
  "facets": [
    {
      "active": true,
      "count": 123,
      "description": "<string>",
      "filter_key": "<string>",
      "key": "<string>",
      "name": "<string>",
      "template_key": "<string>",
      "values": [
        {
          "count": 123,
          "type": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total_items": 123,
    "total_pages": 123
  },
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "error": "<string>"
}

{
  "details": [
    "<string>"
  ],
  "error": "<string>"
}

Path Parameters

app_id

string

required

App ID

Query Parameters

string

required

Search query

page

integer

Page number (default: 1)

per_page

integer

Items per page (default: 20, max: 100)

type

string

Filter by type: image, video, file, all (default: all)

sort_by

string

Sort field: name, created_at, updated_at, type, rank (default: created_at). 'rank' orders by full-text relevance against q.

sort_order

string

Sort order: asc, desc (default: desc)

attributes

string[]

Filter by attribute(s). Repeat the query parameter once per filter, each in the form template_key/attribute_key. Filters sharing the same template_key combine with OR; distinct template_keys combine with AND. Example: ?attributes=color/red&attributes=color/blue&attributes=size/large

Response

Search results with facets

data

object[]

Show child attributes

facets

object[]

Show child attributes

pagination

object

Show child attributes

success

boolean

Error

A valid request URL is required to generate request examples

{
  "data": [
    {
      "alt_text": "<string>",
      "attributes": [
        {
          "description": "<string>",
          "id": "<string>",
          "key": "<string>",
          "name": "<string>",
          "values": {}
        }
      ],
      "blurhash": "<string>",
      "copyright": "<string>",
      "created_at": "<string>",
      "custom": [
        123
      ],
      "description": "<string>",
      "file_type": "<string>",
      "folder": {
        "id": "<string>",
        "name": "<string>",
        "public": true,
        "slug": "<string>"
      },
      "id": "<string>",
      "status": "<string>",
      "title": "<string>",
      "translations": {},
      "type": "<string>",
      "updated_at": "<string>",
      "url": "<string>",
      "variants": [
        {
          "created_at": "<string>",
          "format": "<string>",
          "height": 123,
          "id": "<string>",
          "updated_at": "<string>",
          "url": "<string>",
          "width": 123
        }
      ]
    }
  ],
  "facets": [
    {
      "active": true,
      "count": 123,
      "description": "<string>",
      "filter_key": "<string>",
      "key": "<string>",
      "name": "<string>",
      "template_key": "<string>",
      "values": [
        {
          "count": 123,
          "type": "<string>",
          "value": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total_items": 123,
    "total_pages": 123
  },
  "success": true
}

{
  "details": [
    "<string>"
  ],
  "error": "<string>"
}

{
  "details": [
    "<string>"
  ],
  "error": "<string>"
}