PDFs

Generate a PDF

This endpoint is available to Group API Keys only.

Triggers the asynchronous generation of a PDF document (e.g., an invoice PDF or a rabies certificate). The response includes a unique key that can be used to poll the fetch endpoint until the PDF is ready for download. Once ready for download, PDFs are only available for download for 24 hours. Beyond that window, the PDF must be regenerated.

post/ext/v2/pdfs/generate-pdfs/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/pdfs/generate-pdfs/
  • Auth
    HTTP bearer

Request body

OR
OR

Response

Created

errorstring nullable required

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

file_namestring required

The filename of the generated PDF document.

file_urlstring nullable required

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

keystring required

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

namestring required

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

status'PENDING' | 'SUCCESS' | 'ERROR' required

Changes

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