Get/Export Document

get

https://api.lucid.co/v1/accounts/me/documents/{id}

Retrieves information about a document or exports it as an image for an account owner or document admin. The document must belong to the requesting admin's account. A direct share is not required. Authenticate with an admin OAuth2 scope or a DocumentAdmin API key grant.

Get Document: Returns document metadata, including owner information.

Export Document: Exports a given document in a specified image format. When exporting oversized images, the resolution may be automatically scaled down to enable 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

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

includePageFill

boolean

Defaults to true

Whether PNG exports include the page background. Defaults to true.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

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.

Language

Credentials

Loading…

Response

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

application/json

image/png

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.