Skip to content

List export files​

GET
/v1/projects/{id}/exports

Returns the export files already generated for this book, ready to download — no reprocessing, no GPU cost. A format you haven't generated yet just won't appear here; generate it first with POST /projects/{id}/export.

Authorizations​

Bearer

JWT bearer token from POST /v1/auth/login.

Type
HTTP (bearer)
or
ApiKey

Scoped API key for non-interactive clients (issued by PBI #1426).

Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

id*
Type
string
Required
Format
"uuid"

Responses​

OK

application/json

The file's MIME type.

A sensible save-as name (project + date + format) for a same-origin download.

The export file's name on disk (also the last path segment of string ExportFileView.Url).

The file's size, in bytes, or null when the storage backend
didn't report one.

Format"int64"
Pattern"^-?(?:0|[1-9]\\d*)$"

Relative path to download this file via GET /projects/{id}/exports/{name}.

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI