Get Brand Images

Learn how to retrieve brand assets from your workspace

Updated

GET
/v1/brand-assets/images/get
curl -X GET "https://api.orshot.com/v1/brand-assets/images/get?tag=<TAG>&embedId=<EMBED_ID>&embedUserId=<EMBED_USER_ID>" \
  -H "Authorization: Bearer <ORSHOT_API_KEY>"

Overview#

This endpoint allows you to retrieve a list of brand assets (images) from your workspace. Brand assets can be used across your templates and designs.

It returns the 100 most recent images. Use Search Brand Assets with page and limit to page through more.

Endpoint
https://api.orshot.com/v1/brand-assets/images/get

Query Parameters#

ParameterTypeRequiredDescription
tagStringNoComma-separated list of tags to filter by. Returns only assets that have all specified tags.
embedIdStringNoEmbed instance ID. Pair with embedUserId to scope this call to one embed user
embedUserIdStringNoThe same userId your app passes to the embed URL. Requires embedId

Request#

JavaScript
await fetch("https://api.orshot.com/v1/brand-assets/images/get", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});
JavaScript
await fetch("https://api.orshot.com/v1/brand-assets/images/get?tag=logo,brand", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});
JSON
{
  "data": [
    {
      "id": 101,
      "created_at": "2025-09-10T15:30:45.123Z",
      "direct_url": "https://storage.orshot.com/cloud/w-50/renders/brand_assets/brand-asset-1694444444png-Xk3v9Qp1aBc.png",
      "file_name": "brand-asset-1694444444.png",
      "file_size": 42568,
      "meta": {
        "description": "Company logo",
        "category": "logos"
      },
      "tags": ["logo", "brand"],
      "workspace_id": 50,
      "user_id": "abcdef01-2345-6789-abcd-ef0123456789"
    }
  ]
}

Per-User Libraries#

Pass embedId and embedUserId together to return only that embed user's images instead of the whole workspace library. This is how one embed serves many brands or tenants, each with its own brand space.

Omit them and this endpoint behaves exactly as documented above. See Per-User Brand Assets for the full picture.

Rate Limits#

  • 30 requests per minute per endpoint

Response Fields#

FieldTypeDescription
idNumberUnique identifier for the asset
created_atStringTimestamp when the asset was created
direct_urlStringURL to access the asset. Treat this URL as opaque.
file_nameStringOriginal filename of the asset
file_sizeNumberSize of the file in bytes
metaObjectMetadata you sent with the upload. May include keys Orshot adds about how the file was uploaded.
tagsString[]Tags associated with the asset
workspace_idNumberID of the workspace the asset belongs to
user_idStringID of the user who created the asset
Was this page helpful?

Ready to automate?

Start rendering images, PDFs and videos from your templates in under 2 minutes. Free plan, no credit card.

Get your API key
  • Image, PDF and video generation via API
  • Visual editor with AI and smart layouts
  • Zapier, Make, MCP and 40+ integrations
  • White-label embed for your own app
  • 100 free credits a month, no credit card required