Documents

Briefing document assets generated per token

Get documents

get

Returns paginated briefing documents created by the authenticated token, including in-progress requests.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pageinteger ยท min: 1Optional

Page number (default 1)

pageSizeinteger ยท min: 1 ยท max: 100Optional

Items per page (default 20, max 100)

Responses
chevron-right
200

Paginated list of documents

application/json
totalCountintegerOptional
pageintegerOptional
pageSizeintegerOptional
totalPagesintegerOptional
get
/documents/get

Get document

get

Returns the stored briefing document payload for the authenticated token.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
documentIdstringRequired

Document request identifier

Responses
chevron-right
200

Document payload

application/json
idstringOptional

Unique identifier for the document (matches request id)

typestringOptional

Document type

formatstring ยท enumOptional

Stored result format

Possible values:
titlestring ยท nullableOptional

Optional document title

statusintegerOptional

Current progress percentage (100 when completed)

createdOnstring ยท date-timeOptional

UTC timestamp when the document row was created

contentstring ยท nullableOptional

Text or HTML content when format is text or html

urlstring ยท nullableOptional

Direct PDF URL when format is pdf

get
/documents/{documentId}

Download document

get

Downloads the stored briefing document as PDF, HTML, or text for the authenticated token.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
documentIdstringRequired

Document request identifier

Responses
chevron-right
200

Document download

application/octet-stream
string ยท binaryOptional
get
/documents/{documentId}/download

Last updated