Export Document Asynchronously

post

https://api.lucid.co/v1/documents/{id}/export/jobs

Starts an asynchronous export of one or more document pages.

Admin flow: Account owners and document admins can export any document in their account by setting Lucid-Request-As: admin and authenticating with an admin scope or DocumentAdmin API key grant.

📘
This is a long-running job request endpoint. See Long-Running Jobs.

Path Params

uuid

required

ID of the document to export.

Query Params

pageId

array of strings

ID of a document page to export. Provide multiple pageId query parameters to export multiple pages. Cannot be provided with page.

Example: ?pageId=J~65X_X714o2&pageId=J~65X_X714o3

pageId

page

array of integers

One-based index of a document page to export. Provide multiple page query parameters to export multiple pages. Cannot be provided with pageId.

Example: ?page=1&page=2

page

crop

string

Specifies the crop settings for the document export. Optional for export operation. Possible values are

Default (no crop parameter) - Exports the entire page canvas area that contains your content. Automatically adjusts to include all items on the page, including the space between them and maintains the relative positioning and spacing of your document elements
x, y, width, height - Crop to the specified region (in pixels) on the page. Example crop=1000,300,30,7
- Note: The region (in pixels) is accurate to the number of pixels on the canvas. The number of pixels of the outputted image will only match the crop window at a DPI of 160.
content - Crop to page content. Example crop=content

dpi

integer

Output resolution in dots per inch.

width

integer

Output width in pixels.

aspectRatio

string

enum

Aspect-ratio handling for the exported image.

Allowed:

Headers

Lucid-Request-As

string

enum

Make the request with account-admin permissions. Requires a valid admin scope or DocumentAdmin API key grant.

Allowed:

Idempotency-Key

string

Distinguishing key for duplicate job requests. Use a different value if intending to run the same job twice.

Responses

400

Bad Request. A parameter is invalid, or page and pageId were both provided.

403

Forbidden. The caller does not have permission to export the document.

404

Not Found. The document or a requested page does not exist.

406

Not Acceptable. The requested export format is not supported.

429

Too Many Requests. The account exceeded the export rate limit.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

This is a long-running job request endpoint. See Long-Running Jobs​.

200OK. Returns the identifier of the queued or existing export job.

This is a long-running job request endpoint. See Long-Running Jobs.