LUlucid
Document Access

Create Asynchronously

Changed on

Starts an asynchronous import of a document file. This endpoint will immediately reserve a document ID, but the document is not necessarily created nor populated until the job has succeeded.

The uploaded file must not exceed 50 MB.

Synchronous and asynchronous file imports share a per-account rate limit.

post/v1/documents/import/jobs

Request

  • Base URL
    https://api.lucid.co
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization codehttps://lucid.app/oauth2/authorize
      Token URLhttps://api.lucid.co/oauth2/token
      Scopeslucidchart.document.content, lucidchart.document.app.folder, lucidspark.document.content, lucidspark.document.app.folder
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Headers

Idempotency-Keystring

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

Request body multipart/form-data

filestring binary required

The file to import. Maximum size is 50 MB.

type'x-application/vnd.lucid.board' | 'x-application/vnd.lucid.bpmn' | 'x-application/vnd.lucid.confluence-onprem' | 'x-application/vnd.lucid.drawio' | 'x-application/vnd.lucid.gliffy' | 'x-application/vnd.lucid.graffle' | 'x-application/vnd.lucid.lucidArchive' | 'x-application/vnd.lucid.miro' | 'x-application/vnd.lucid.mural' | 'x-application/vnd.lucid.standardImport' | 'x-application/vnd.lucid.visio' required

MIME type describing the supplied import file.

product'lucidchart' | 'lucidspark'

The Lucid Suite product types that can be created.

titlestring

Title for the imported document. Defaults to the file name without its extension.

parentinteger

Folder ID in which to create the imported document. Cannot be provided with team.

teamstring

Team ID whose folder should contain the imported document. Cannot be provided with parent.

Example request

{
  "product": "lucidchart"
}

Response

OK. Returns the queued or existing import job and the ID reserved for the imported document.

jobIdstring required

Unique identifier for an asynchronous job

Example response

{
  "jobId": "jobr_2f5e5b82-6f1d-4c9f-932a-14e43cf30454"
}

Changes