Skip to main content
POST
Request a bulk file download

Authorizations

Authorization
string
header
required

Cognito-issued JWT access token. Send it as Authorization: Bearer <token>.

Body

application/json
files
string<uuid>[]
required

File UUIDs to include in the archive. The maximum count is enforced server-side via MAX_BULK_DOWNLOAD_FILE_COUNT.

fileName
string

Optional download filename. Defaults to server-generated naming convention.

Response

Bulk download job accepted and enqueued.

id
string<uuid>
required
status
enum<string>
required
Available options:
pending,
processing,
done,
failed
pollUrl
string
required