Covers

Presign a reference-image upload

Mints a short-lived (5 minute) presigned PUT URL for a reference image and returns the upload_id to pass to POST /api/v1/covers/generate-reference. FREE: consumes no credits. The storage key is server-generated — the client cannot choose it. Nothing about the object is trusted here: size, dimensions, and content-policy checks all run when a generation call consumes the upload_id, before any credit is reserved. Upload the bytes with a plain PUT to upload_url using the same Content-Type you declared.

post/api/v1/uploads

Request

  • Base URL: https://beyourcover.com
  • URL: https://beyourcover.com/api/v1/uploads
  • Auth: HTTP bearer

Request body

content_type'image/jpeg' | 'image/png' | 'image/webp' required

MIME type of the image you are going to upload.

size_bytesinteger

Optional declared byte size; rejected early with file_too_large when it exceeds the limit returned in max_bytes.

Response

Presigned upload minted.

upload_idstring required

Opaque id for the staged upload. Pass it in reference_upload_ids.

upload_urlstring uri required

Presigned URL to PUT the image bytes to, using the declared Content-Type.

expires_atstring date-time required

When upload_url stops working (5 minutes after minting).

max_bytesinteger required

Maximum accepted image size in bytes.

allowed_typesstring[] required

Accepted MIME types.

Changes

No recorded changes to this operation across all 1 revision of this API.