Sync Conversion

The sync conversion endpoint generates a PDF and provides a downloadable URL once the conversion is complete. This method is ideal for workflows where real-time access is not required, but the PDF can be downloaded via url.

Endpoint Details

Method: POST

https://api.pdfbolt.com/v1/sync

Example

Below is an example demonstrating a request and its corresponding response:

Request

{
  "url": "https://example.com"
}

Response

{
  "requestId": "ee57bcb5-b02b-4ae7-af37-6e91549f647d",
  "status": "SUCCESS",
  "errorCode": null,
  "errorMessage": null,
  "documentUrl": "https://s3.pdfbolt.com/pdfbolt_dd3f57ef-ea17-48a9-930a-8990ee7f52a7_2024-12-30T14-26-23Z.pdf",
  "expiresAt": "2024-12-31T14:26:23Z",
  "isAsync": false,
  "duration": 1168,
  "documentSizeMb": 0.04,
  "isCustomS3Bucket": false
}

Body Parameters

info

In this section, you will find only the parameters specific to the /sync endpoint. To view the list of common parameters shared across all endpoints, please refer to the Conversion Parameters section.

customS3PresignedUrl

Type: string

Required: No

Details: The customS3PresignedUrl allows you to specify a URL for direct upload to your S3 bucket. If not provided, the document is stored in our S3 bucket for 24 hours.

See Uploading to Your S3 Bucket for setup details.

Usage:

{
  "url": "https://example.com",
  "customS3PresignedUrl": "https://s3-your-custom-bucket.com?token=abcdef"
}

contentDisposition

Type: string

Required: No

Default Value: inline

Details: This parameter specifies how the content should be presented when downloaded from the S3 bucket:

• inline - the PDF will be displayed directly in the browser.
• attachment - the PDF will be downloaded as a file, prompting the user with a Save As dialog.

Usage:

{
  "url": "https://example.com",
  "contentDisposition": "attachment"
}

Response Parameters

The table below outlines the structure of the response for a successful request. To learn more about the structure of responses for failed requests, refer to the Error Response Format.

Parameter	Type	Description	Possible Values	Example Value
requestId	string (UUID)	Unique identifier for the request.	Any valid UUID	ee57bcb5-b02b-4ae7-af37-6e91549f647d
status	string (Enum)	Status of the request.	SUCCESS	SUCCESS
errorCode	string	Error code. This field is null for successful requests.	null	null
errorMessage	string	Error message. This field is null for successful requests.	null	null
documentUrl	string (URL)	URL to the generated document. This will be null if customS3PresignedUrl is used, as the PDF is uploaded directly to the provided S3 bucket.	Any valid URL or null	https://s3-your-custom-bucket.com/document.pdf
expiresAt	string (ISO 8601)	Expiration date and time of the document stored in the default PDFBolt S3 bucket. Will be null if customS3PresignedUrl is provided.	ISO 8601 datetime string in UTC or null	2024-11-19T23:59:59Z
isAsync	boolean	Indicates if the operation is asynchronous. Will always be false for the /sync endpoint.	false	false
duration	number	Total processing time for the request. Measured in milliseconds.	Any positive number	1000
documentSizeMb	number	Size of the document in megabytes.	Any positive number	0.55
isCustomS3Bucket	boolean	Indicates if the generated document was uploaded to a user-provided custom S3 bucket or PDFBolt's default storage.	true false	false