ORorshot
Images

Upload Brand Image

Changed on

Learn how to upload brand assets to your workspace

post/brand-assets/images/add

Request

  • Base URL
    https://api.orshot.com/v1
  • URL
    https://api.orshot.com/v1/brand-assets/images/add
  • Auth
    HTTP bearer

Query parameters

embedIdstring

Embed instance ID. Pair with embedUserId to scope this call to one embed user

embedUserIdstring

The same userId your app passes to the embed URL. Requires embedId

Request body

filestring required

URL, binary or base64-encoded string of the image

fileNamestring

Custom filename for the asset (default: auto-generated based on timestamp)

fileTypestring

MIME type of the file (e.g., "image/png"). If omitted, the type comes from the URL's Content-Type or extension, or from the data: prefix. Raw base64 without a prefix is treated as PNG, so pass fileType for SVG, JPEG, WebP or GIF

tagsstring[]

Array of tags to associate with the asset (e.g., ["logo", "brand"])

metaobject

Arbitrary metadata to store with the asset (e.g., { "source": "product-catalog" })

Response

Successful response

object required

Changes

  • a0c2c3003dc0Revision changes
    • info

      added the non-success response with the status

  • b2284a52aaadRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status