Get Videos

Learn how to retrieve brand videos from your workspace

Published ·Updated

GET
/v1/brand-assets/videos/get
curl -X GET "https://api.orshot.com/v1/brand-assets/videos/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 videos from your workspace. Brand videos can be used across your templates and designs.

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

Query Parameters#

ParameterTypeRequiredDescription
tagStringNoComma-separated list of tags to filter by. Returns only videos 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/videos/get", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});
JavaScript
await fetch("https://api.orshot.com/v1/brand-assets/videos/get?tag=intro,brand", {
  method: "GET",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
});
JSON
{
  "data": [
    {
      "id": 789,
      "created_at": "2025-09-10T15:30:45.123Z",
      "name": "brand-intro.mp4",
      "original_filename": "brand-intro.mp4",
      "file_size": 5242880,
      "direct_url": "https://storage.orshot.com/videos/workspace_id/brand-intro.mp4",
      "width": 1920,
      "height": 1080,
      "duration": 30.5,
      "format": "mp4",
      "mime_type": "video/mp4",
      "metadata": {},
      "tags": ["intro", "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 videos 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 video
created_atStringTimestamp when the video was uploaded
nameStringVideo name
original_filenameStringOriginal filename of the uploaded video
file_sizeNumberSize of the video file in bytes
direct_urlStringURL to access the video
widthNumberVideo width in pixels
heightNumberVideo height in pixels
durationNumberVideo duration in seconds
formatStringVideo format (e.g., mp4, webm)
mime_typeStringMIME type of the video
metadataObjectCustom metadata associated with the video
tagsString[]Tags associated with the video
workspace_idNumberID of the workspace the video belongs to
user_idStringID of the user who uploaded the video
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
  • 100 free credits a month, no credit card required