Uploads

Upload files

Make local files available to Rainbrand requests, such as Acme Inc.'s brand guide or an Atlas Pro product photo.

This endpoint reserves storage and returns an uploadUrl for each file. Send each file's raw bytes with PUT to its uploadUrl, using the returned headers.

Once the upload is complete, use uploadId to:

  • Supply file sources when you add a brand or prepare a Brand Edit.
  • Save media in a Brand Library for reuse.
  • Upload a custom brand font.
  • Request a Review of an image or provide supporting images.

For generation requests, pass the returned url where the model's input schema expects a file URL. Set contentType on this upload request to match the file. The uploadUrl is only for sending the bytes.

Uploads are temporary and expire at expiresAt. Uploading alone does not add the file to a brand or its Library.

post/uploads

Request

  • Base URL
    https://www.rainbrand.com/api/v1
  • URL
    https://www.rainbrand.com/api/v1/uploads
  • Auth
    • API key in header x-api-key
    • or HTTP bearer
    • or OAuth 2
      Authorization code: https://www.rainbrand.com/api/auth/oauth2/authorize
      Token URL: https://www.rainbrand.com/api/auth/oauth2/token

Request body

workspaceIdstring

Team ID from GET /workspaces. Omit for your personal account.

Example request

{
  "files": [
    {
      "filename": "atlas-pro-front.png",
      "byteLength": 1458200,
      "contentType": "image/png"
    }
  ]
}

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.