PDFs

Get a document

get/v1/pdf/{id}

Request

  • Base URL: https://api.castpdf.com
  • URL: https://api.castpdf.com/v1/pdf/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The id (UUID).

Response

OK

idstring uuid
status'queued' | 'processing' | 'succeeded' | 'failed' | 'canceled'
pagesinteger nullable
bytesinteger nullable
mode'fast' | 'print' | 'null' nullable
testboolean
template_idstring nullable
template_versioninteger nullable
error_codestring nullable
created_atstring date-time
expires_atstring date-time nullable
urlstring uri nullable

Signed download link, valid until expires_at.

thumbnail_urlstring uri nullable

Signed PNG of the first page (480 px wide) while the PDF is stored; made on first request. In GET /v1/pdf/{id} and GET /v1/documents, not in webhook events.

Changes

No recorded changes to this operation across all 1 revision of this API.