Skip to main content
POST
Create a file preview
Create a short-lived presigned preview URL for a single file. The input should contain the following information:
  • s3Path: the path of the file in the S3 bucket
Need URLs for several files? Use POST /files/preview/batch to sign up to 100 paths in one request instead of looping over this endpoint.
Presigned URLs are short-lived (about one hour). Request them when you are ready to use them rather than caching them.

Idempotency

Idempotency-Key is accepted for client uniformity but ignored here: the presigned URL expires well inside the 24-hour replay window, so a replayed response would hand back a URL that is already dead. Every request executes fresh. See Idempotent requests.

Authorizations

x-api-key
string
header
required

API key for authentication

Headers

Idempotency-Key
string

Accepted for client uniformity but IGNORED on this endpoint. It has no side effects, and its presigned URLs expire in an hour — well inside the 24h replay window — so a replayed response would carry URLs that are already dead against S3. Every request executes fresh: no 24h window, no replay, no Idempotent-Replayed header, and no key-reuse 422.

Body

application/json
s3Path
string
required

S3 Path

Example:

"s3://orion.com/649e2d2d2d2d2d2d2d2d2d2d"

Response

The signed URL for the file preview is retrieved

signedUrl
string