HEheygen
Assets

Search assets (images and icons)

Changed on

Semantically search re-hosted public images and icons by natural-language description, e.g. 'pepperoni pizza on a wooden table' or 'minimalist rocket icon'. Returns assets ranked by similarity, each with a stable public URL, plus cursor-based pagination.

get/v3/assets/search

Request

  • Base URL
    https://api.heygen.com
  • URL
    https://api.heygen.com/v3/assets/search
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

querystring required

Natural-language description of the image or icon you want, e.g. 'pepperoni pizza on a wooden table' or 'minimalist rocket icon'. Results are ranked by semantic similarity.

limitinteger

Maximum number of results to return (1-50).

tokenstring

Opaque cursor token for the next page, taken from 'next_token' in a prior response.

type'image' | 'icon' required

Asset type to search (image or icon).

scope'public' | 'personal'

Which assets to search: 'public' (the shared catalog, default) or 'personal' (your own space's assets).

Response

Successful response

has_moreboolean

Whether more pages are available

next_tokenstring nullable

Opaque cursor for the next page

Example response

{
  "data": [
    {
      "id": "9f8a3c1bd4e2f6a7.png",
      "url": "https://static.example.com/assets/9f8a3c1bd4e2f6a7.png",
      "width": 1024,
      "height": 768,
      "orientation": "landscape",
      "is_transparent": true
    }
  ]
}

Changes