Skip to content
Esc
↑↓navigate↵open⌘Jpreview

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/v1/{app_id}/media/search
Authorization
AuthorizationAPI key · headerrequired

Bearer token (format: "Bearer {token}")

Path parameters
app_idstringrequired

App ID

Query parameters
qstringrequired

Search query

pageinteger

Page number (default: 1)

per_pageinteger

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

typestring

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

sort_bystring

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

sort_orderstring

Sort order: asc, desc (default: desc)

attributesstring[]

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

Responses
200

Search results with facets

datainternal_pkg_webserver_public-webserver_v1.MediaItemResponse[] | null
Show properties
Array of internal_pkg_webserver_public-webserver_v1.MediaItemResponse
alt_textstring | null
attributesAttributeResponse[] | null
Show properties
Array of AttributeResponse
descriptionstring
idstring
keystring
namestring
valuesobject | null
blurhashstring | null
copyrightstring | null
created_atstring
custominteger[] | null
descriptionstring | null
file_typestring | null
folderFolderRef | null
Show properties
Any of:
FolderRef
idstring
namestring
publicboolean
slugstring
null
null
idstring
statusstring | null
titlestring | null
translationsMediaItemTranslations
Show properties
altTranslation[] | null
Show properties
Array of Translation
idstring
localestring
valuestring
descriptionTranslation[] | null
titleTranslation[] | null
typeTranslation[] | null
typestring
updated_atstring | null
urlstring
variantsVideoVariantResponse[] | null
Show properties
Array of VideoVariantResponse
created_atstring
formatstring
heightinteger
idstring
updated_atstring
urlstring
widthinteger
facetsFolderFacetResponse[] | null
Show properties
Array of FolderFacetResponse
activeboolean
countinteger
descriptionstring
filter_keystring
keystring
namestring
template_keystring
valuesFolderFacetValueResponse[] | null
Show properties
Array of FolderFacetValueResponse
countinteger
typestring
valuestring
paginationinternal_pkg_webserver_public-webserver_v1.PageInfo
Show properties
pageinteger
per_pageinteger
total_itemsinteger
total_pagesinteger
successboolean
400

Invalid request

detailsstring[] | null
errorstring
500

Internal server error

detailsstring[] | null
errorstring
Try it
Server
Authorization
Parameters
Request
curl -X GET '//dam.enad.io/api/v1/string/media/search?q=string' \
  -H 'Authorization: YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "alt_text": "string",
      "attributes": [
        {
          "description": "string",
          "id": "string",
          "key": "string",
          "name": "string",
          "values": {
            "property1": [
              {
                "type": "string",
                "value": "string"
              }
            ],
            "property2": [
              {
                "type": "string",
                "value": "string"
              }
            ]
          }
        }
      ],
      "blurhash": "string",
      "copyright": "string",
      "created_at": "string",
      "custom": [
        0
      ],
      "description": "string",
      "file_type": "string",
      "folder": {
        "id": "string",
        "name": "string",
        "public": true,
        "slug": "string"
      },
      "id": "string",
      "status": "string",
      "title": "string",
      "translations": {
        "alt": [
          {
            "id": "string",
            "locale": "string",
            "value": "string"
          }
        ],
        "description": [
          {
            "id": "string",
            "locale": "string",
            "value": "string"
          }
        ],
        "title": [
          {
            "id": "string",
            "locale": "string",
            "value": "string"
          }
        ],
        "type": [
          {
            "id": "string",
            "locale": "string",
            "value": "string"
          }
        ]
      },
      "type": "string",
      "updated_at": "string",
      "url": "string",
      "variants": [
        {
          "created_at": "string",
          "format": "string",
          "height": 0,
          "id": "string",
          "updated_at": "string",
          "url": "string",
          "width": 0
        }
      ]
    }
  ],
  "facets": [
    {
      "active": true,
      "count": 0,
      "description": "string",
      "filter_key": "string",
      "key": "string",
      "name": "string",
      "template_key": "string",
      "values": [
        {
          "count": 0,
          "type": "string",
          "value": "string"
        }
      ]
    }
  ],
  "pagination": {
    "page": 0,
    "per_page": 0,
    "total_items": 0,
    "total_pages": 0
  },
  "success": true
}