Lucid Document Access API is one of 37 APIs that Lucid publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Document Access. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
10 operations
across 9 paths,
and defines 61 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against a single base URL, https://api.lucid.co.
The identity and technical contract details declared by the specification.
LucidStandardImportToggleLayerAction
object
Toggle visibility of layers.
2 properties
2 required
EndpointStyle
string
The visual style of a line endpoint.
LucidStandardImportPositionEndpoint
object
An endpoint at an absolute position on the page.
3 properties
3 required
Line
object
Object representing a line on the page of a document. Note that the ItemId of a line is unique across all groups, layers, shapes, and lines.
6 properties
6 required
LucidStandardImportCollection
object
A data collection to associate with the document. Exactly one of dataSource or values must be provided — providing both or neither is an error.
1 property
1 required
LucidStandardImportStandardPageSize
object
A standard named page size.
2 properties
1 required
LucidStandardImportHideLayerAction
object
Hide layers.
2 properties
2 required
Group
object
Object representing a group on the page of a document. Note that the ItemId of a group is unique across all groups, layers, shapes, and lines.
4 properties
2 required
AbsolutePoint
object
An absolute point on the page canvas.
2 properties
2 required
Data
object
Object representing an array of Collections on a document.
1 property
1 required
LucidStandardImportUrlAction
object
Navigate to an external URL.
3 properties
2 required
LucidStandardImportShowLayerAction
object
Show layers.
2 properties
2 required
LucidStandardImportPageSettings
object
Page-level settings for a Lucid Standard Import page.
5 properties
LucidStandardImportLineEndpoint
object
An endpoint connected to another line.
4 properties
4 required
LucidStandardImportGroup
object
A group of items on a page.
6 properties
1 required
Contains
object
Object listing the IDs of items contained within a container shape (e.g., a frame).
3 properties
3 required
LucidStandardImportShape
object
A shape definition within a page. The type field determines which kind of shape to create. Common shape types include rectangle, circle, diamond, cloud, proces…
11 properties
3 required
Product
string
The Lucid Suite product that a document was created in.
LucidStandardImportGotoDocumentAction
object
Navigate to a page in another document.
4 properties
3 required
LucidStandardImportColorFill
object
A solid color fill.
2 properties
2 required
LucidStandardImportStyle
object
Visual style properties for a shape.
4 properties
LucidStandardImportStroke
object
Stroke styling for a line.
3 properties
Page
object
Object representing a single page of a Lucidchart document.
6 properties
6 required
LucidStandardImportContent
object
Defines the content of a document using the Lucid Standard Import format, including pages, shapes, and lines. Mutually exclusive with extensionBootstrapData.
4 properties
2 required
LucidStandardImportLine
object
A line definition within a page.
13 properties
4 required
PatchDocumentRequestBody
object
Request body for updating a document. At least one field should be provided.
4 properties
Document
object
22 properties
15 required
Items
object
Individual shapes, lines, groups, and layers all contain a unique ItemId identifying the object.
4 properties
4 required
Shape
object
Object representing a shape placed on a page of a document. Note that the ItemId of a shape is unique across all groups, layers, shapes, and lines.
8 properties
5 required
CreatableProduct
string
The Lucid Suite product types that can be created.
LinkedData
object
Object representing data linked to a resource on a document.
3 properties
2 required
DocumentOwner
object
3 properties
DocumentContent
object
Object representing the contents of a Lucidchart document
6 properties
6 required
Collection
object
A collection is a container inside of a source of data. A data source can have many collections, but a collection can only belong to one data source. A collect…
3 properties
3 required
LucidStandardImportPage
object
A page definition within a Lucid Standard Import document.
9 properties
2 required
BoundingBox
object
The bounding box that defines a shape's position and size on the page.
4 properties
4 required
CustomAttribute
object
Object representing a custom attribute value for a document.
3 properties
1 required
LucidStandardImportLineText
object
A text label on a line.
3 properties
1 required
Image
object
Object describing the image fill on a shape.
3 properties
1 required
LucidStandardImportAction
object
An interactive action attached to a shape. The type field determines the action kind.
LucidStandardImportGenerator
object
A data-backed shape generator that automatically creates shapes from data. The type field determines which generator is used.
1 property
1 required
LucidStandardImportLinkedDatum
object
A reference linking an item to a data collection entry.
2 properties
2 required
Repository
object
1 property
AccountDocument
object
14 properties
10 required
LucidStandardImportPageSize
Page size configuration. Either a standard page size with an optional format, or a custom size with explicit dimensions.
LucidStandardImportShapeEndpoint
object
An endpoint connected to a shape.
4 properties
3 required
RelativePoint
object
A relative point with coordinates between 0 and 1, inclusive.
2 properties
2 required
LucidStandardImportCustomPageDatum
object
A custom key-value pair attached to a page, optionally globally inherited.
3 properties
2 required
TextArea
object
Object representing a text area on a Shape or Line.
2 properties
2 required
LucidStandardImportImageFill
object
An image fill, either by URL or by reference to an image in the import archive.
4 properties
1 required
LucidStandardImportCustomDatum
object
A custom key-value pair attached to an item.
2 properties
2 required
LucidStandardImportFill
Fill style for a shape. The type field determines the fill kind. - color: A solid color fill. - image: An image fill, either by URL or by reference to an image…
Endpoint
object
Object representing the endpoint of a Line.
2 properties
2 required
DataPair
object
Object representing a key-value pair of data.
2 properties
2 required
LucidStandardImportEndpoint
object
An endpoint of a line. The type field determines how the endpoint is positioned. - shapeEndpoint: Connects to a shape by its ID. - positionEndpoint: Connects t…
BootstrapData
object
Bootstrap data can be attached to the created document to be consumed by a specific Extension Package.
4 properties
4 required
LucidStandardImportDocumentSettings
object
Document-level settings for a Lucid Standard Import.
1 property
Layer
object
Object representing a layer on the page of a document. Note that the ItemId of a layer is unique across all groups, layers, shapes, and lines.
5 properties
5 required
LucidStandardImportGotoPageAction
object
Navigate to a page in the current document.
2 properties
2 required
LucidStandardImportCustomPageSize
object
A custom page size with explicit dimensions.
2 properties
2 required
LucidStandardImportLayer
object
A layer on a page. Layers can contain shapes, lines, and groups.
7 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Lucid publishes across the network.
