Get Brand Images

Learn how to retrieve brand assets from your workspace

Updated Apr 6, 2026

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>"

const res = await fetch("https://api.orshot.com/v1/brand-assets/images/get?tag=<TAG>&embedId=<EMBED_ID>&embedUserId=<EMBED_USER_ID>", {
  method: "GET",
  headers: {
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});

const data = await res.json();

import requests

response = requests.get(
    "https://api.orshot.com/v1/brand-assets/images/get?tag=<TAG>&embedId=<EMBED_ID>&embedUserId=<EMBED_USER_ID>",
    headers={"Authorization": "Bearer <ORSHOT_API_KEY>"},
)

data = response.json()

$ch = curl_init("https://api.orshot.com/v1/brand-assets/images/get?tag=<TAG>&embedId=<EMBED_ID>&embedUserId=<EMBED_USER_ID>");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <ORSHOT_API_KEY>",
]);

$data = json_decode(curl_exec($ch), true);
curl_close($ch);

require "net/http"
require "json"

uri = URI("https://api.orshot.com/v1/brand-assets/images/get?tag=<TAG>&embedId=<EMBED_ID>&embedUserId=<EMBED_USER_ID>")
req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer <ORSHOT_API_KEY>"

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

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.

Endpoint

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

Query Parameters#

Parameter	Type	Required	Description
`tag`	String	No	Comma-separated list of tags to filter by. Returns only assets that have all specified tags.
`embedId`	String	No	Embed instance ID. Pair with `embedUserId` to scope this call to one embed user
`embedUserId`	String	No	The 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/brand-assets/workspace_id/brand-asset-1694444444.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"
    }
  ]
}

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#

Field	Type	Description
`id`	Number	Unique identifier for the asset
`created_at`	String	Timestamp when the asset was created
`direct_url`	String	URL to access the asset
`file_name`	String	Original filename of the asset
`file_size`	Number	Size of the file in bytes
`meta`	Object	Custom metadata associated with the asset
`tags`	String[]	Tags associated with the asset
`workspace_id`	Number	ID of the workspace the asset belongs to
`user_id`	String	ID 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 50+ integrations
White-label embed for your own app
30 free credits — no credit card required