LUlucid
Document Access

Get Document Export Job Status

Changed on

Retrieves the status of an asynchronous document export. When the job succeeds, response.downloadUrl contains a temporary URL for downloading the export.

get/v1/documents/{id}/export/jobs/{jobId}

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:readonly, lucidchart.document.content:admin.readonly, lucidchart.document.app.picker:readonly, lucidchart.document.app.folder, lucidscale.document.content:readonly, lucidscale.document.content:admin.readonly, lucidscale.document.app.picker:readonly, lucidscale.document.app.folder, lucidspark.document.content:readonly, lucidspark.document.content:admin.readonly, lucidspark.document.app.picker:readonly, lucidspark.document.app.folder
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

ID of the document being exported.

jobIdstring required

Unique identifier for an asynchronous job

Example:jobr_2f5e5b82-6f1d-4c9f-932a-14e43cf30454

Identifier returned when the export job was created.

Response

OK. Returns the job status and, after a successful export, the download URL.

jobIdstring required

Unique identifier for an asynchronous job

status'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'FAILED' required

Current status of the export job.

Example response

{
  "jobId": "jobr_2f5e5b82-6f1d-4c9f-932a-14e43cf30454",
  "response": {
    "downloadUrl": "https://download.example/exported-url"
  }
}

Changes