Skip to main content
GET
Fetch a Generated PDF

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

key
string
required

The key of the generated PDF to fetch

Response

200 - application/json

OK

Schema for the PDF detail view

error
string | null
required

An error message if the PDF generation failed. Null on success.

file_name
string
required

The filename of the generated PDF document.

file_url
string | null
required

A pre-signed URL to download the generated PDF. Null if the PDF is still being generated or generation failed.

key
string
required

The unique key used to identify and retrieve this generated PDF.

name
string
required

A human-readable name describing the type of PDF that was generated.

status
enum<string>
required

The current generation status of the PDF.

Available options:
PENDING,
SUCCESS,
ERROR