Get/Export Document

get

https://api.lucid.co/documents/{id}

Get Document

Retrieves information about the requested document. Requires at least read only access to the requested document. It supports both Account and User token types.

Export Document

Exports a given document in a specified image format. Requires at least read only access to the requested document. It supports only User token type.

📘
Export endpoint has a per account rate limit of 75 requests per 5 seconds.

Valid Access Token Types

Account (Only for Get endpoint)

User

Valid Access Scopes

lucidchart.document.content:readonly

lucidchart.document.app.picker:readonly

lucidchart.document.app.folder

lucidscale.document.content:readonly

lucidscale.document.app.picker:readonly

lucidscale.document.app.folder

lucidspark.document.content:readonly

lucidspark.document.app.picker:readonly

lucidspark.document.app.folder

📘
The document owner information is only returned if the requesting user has view access and the document is unpublished. If the document is published, the user must be at least a collaborator on the document. If the document is owned by a user, information about the user is returned. If the document is in an enclosing project/team folder, information about the account is returned instead.
When exporting an image that is too large, the resolution of the image may be scaled down automatically to allow for performant API requests.

Path Params

uuid

required

ID of the document to be retrieved or exported.

Query Params

page

number

Defaults to 1

1-based page index of the document to export. Defaults to the first page. Only a single page is allowed. Optional for export operation. Cannot be provided when pageId is provided.

pageId

string

Specific page of the document to export. Only a single page is allowed. Optional for export operation. Cannot be provided when page is provided.

crop

string

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

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

Headers

Lucid-Api-Version

string

required

Defaults to 1

The API version used in the request.

string

When using the Export Document API, the format of the exported document is set via the Accept header. This header contains up to two parts, separated by a semicolon:

A prefix stating which type of image you would like the document exported as. Options are:
- image/jpeg
- image/png
Optionally, you can also supply the dots per inch (DPI) you want the exported image to have. If this value is not provided, a default of 160 will be used. For example:
- image/png;dpi=256
- image/jpeg;dpi=64

Responses

400

Bad Request. More than one page and/or pageId was provided for export.

403

Forbidden. The app making the request does not have permission to the document, or if the document has been deleted or does not exist.

404

Not Found. The specified page or pageID could not be found for export.

406

Not Acceptable. The specified image type is not supported for export.

429

Too Many Requests. If the account makes more than 75 requests in 5 seconds.

Valid Access Token Types

Valid Access Scopes

200OK with Document resource containing information about the requested document or the binary data in the response body for exports. The Accept header specifies the type of image for exports.