Skip to main content
POST
storage.object.download-url

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
bucket
string
required

The bucket name, as returned by storage.buckets.list.

Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,99}$
path
string
required

Path of the file, e.g. users/42.png.

Maximum string length: 1024
expiresIn
number | null

Seconds the URL stays valid, 1 to 3600. Default 300.

Required range: 1 <= x <= 3600

Response

The result

downloadUrl
string
required

Signed URL. Anyone holding it can download the file until it expires.

expiresAt
string
required

When the URL stops working, ISO 8601.