POST: Brand Asset Image

Overview

This endpoint allows you to upload new brand assets (images) to your workspace. You can upload images from a URL or as a base64-encoded string.

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

Request

await fetch("https://api.orshot.com/v1/brand-assets/images/add", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: "Bearer <ORSHOT_API_KEY>",
  },
  body: JSON.stringify({
    file: "https://example.com/path/to/image.png",
    fileName: "company-logo.png", // optional
    fileType: "image/png", // optional
  }),
});

Request Parameters

Supported Image Formats

• PNG (image/png)
• JPEG (image/jpeg)
• WebP (image/webp)
• SVG (image/svg+xml)
• GIF (image/gif)

Notes

• Images are automatically optimized and resized if needed (maximum dimensions: 2000x2000 pixels)
• Maximum file size: 3MB
• SVG files are not optimized to preserve their vector format

Rate Limits

• 30 requests per minute per endpoint