Get PDF Document

Retrieve the generated PDF document for a specific output and bundle. The PDF can be returned as a raw file download or as a base64-encoded string in JSON.

All endpoints require authentication. For credentials and access, contact the medWrite team.

Request

GET {{baseUrl}}/api/v1/third-parites/letters/{Output ID}/{Bundle ID}/pdf/

Headers

Header	Type	Required	Description
Bearer Token	string	Yes	Authentication token. Contact medWrite team.
API Key	string	Yes	Service API key. Contact medWrite team.

Path parameters

Parameter	Type	Required	Description
Output ID	string	Yes	The unique identifier of the output.
Bundle ID	string	Yes	The unique identifier of the bundle.

Query parameters

Parameter	Type	Required	Default	Description
Return as File	string	No	—	Set to `true` to download the raw PDF file. Omit for base64 JSON.

Response (file download)

Status: 200 OK — Returns a binary PDF file.

Content-Type: application/pdf
Content-Disposition: attachment; filename="<filename>.pdf"

Response (base64)

Status: 200 OK

{
  "data": "<base64_encoded_pdf>",
  "status": "success"
}

Error responses

Status	Condition
`400`	Missing Output ID or Bundle ID
`401`	Invalid or missing authentication
`404`	Output not found

Authentication

Get Records

HL7 Receiver

Request

Headers

Path parameters

Query parameters

Response (file download)

Response (base64)

Error responses

Next steps

Get Approved Outputs

Mark Output Completed

​Request

​Headers

​Path parameters

​Query parameters

​Response (file download)

​Response (base64)

​Error responses

​Next steps

Get Approved Outputs

Mark Output Completed

Request

Headers

Path parameters

Query parameters

Response (file download)

Response (base64)

Error responses

Next steps