Skip to content
Admin API reference
/
v4 API
/Component Library/
Generate Thumbnail Upload...

Generate Thumbnail Upload URL

Request

Generates a pre-signed URL for securely uploading a thumbnail image. The link expires after 10 minutes.

Considerations:

  • Uploaded images are not optimized by the server; please upload images pre-optimized for web use.
  • Each uploaded file receives a unique thumbnailId for reference within your application, but the file name in the bucket is derived from this ID, ensuring no conflicts with existing files.
Security
ZephrHmacHttp
Bodyapplication/jsonrequired
fileNamestring

The name of the file. Unique file names are recommended but not enforced; the system generates a unique ID for each upload.

Example:"unique-thumbnail.jpg"
contentTypestring

The MIME type of the file. Supported MIME types include image/jpeg, image/png, and image/gif.

Example:"image/jpeg"
{
  "fileName": "unique-thumbnail.jpg",
  "contentType": "image/jpeg"
}

Responses

Successfully generated URL for thumbnail upload.

Bodyapplication/json
idstring

A unique identifier for the uploaded thumbnail, used for referencing in the application.

uploadUrlstring

The pre-signed URL for uploading the thumbnail.

Response
{
  "id": "4f5c49a5-e433-4ac1-b0ad-d67897988899",
  "uploadUrl": "https://zephr-thumbnails.s3.amazonaws.com/{generated-path}?..."
}