Lucidchart Documents API

The Documents API from Lucidchart — 2 operation(s) for documents.

OpenAPI Specification

lucidchart-documents-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Lucid REST Documents API
  description: 'The Lucid REST API allows developers to programmatically create, read,

    update, and manage Lucid documents and folders across Lucidchart,

    Lucidspark, and Lucidscale. Authentication is via OAuth 2.0 bearer tokens

    or API keys.

    '
  version: '1.0'
  contact:
    name: Lucid Developer Platform
    url: https://developer.lucid.co/
  license:
    name: Proprietary
    url: https://www.lucidchart.com/pages/tos
servers:
- url: https://api.lucid.co
  description: Lucid REST API
security:
- BearerAuth: []
tags:
- name: Documents
paths:
  /v1/documents:
    post:
      tags:
      - Documents
      summary: Create a document
      operationId: createDocument
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - title
              - product
              properties:
                title:
                  type: string
                product:
                  type: string
                  enum:
                  - lucidchart
                  - lucidspark
                parent:
                  type: number
                  description: Optional parent folder ID
                extensionBootstrapData:
                  type: object
                  description: Mutually exclusive with `content`
                content:
                  type: object
                  description: Mutually exclusive with `extensionBootstrapData`
      responses:
        '201':
          description: The created document
          content:
            application/json:
              schema:
                type: object
  /v1/documents/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Documents
      summary: Retrieve a document
      operationId: getDocument
      responses:
        '200':
          description: The document
          content:
            application/json:
              schema:
                type: object
    delete:
      tags:
      - Documents
      summary: Trash a document
      operationId: deleteDocument
      responses:
        '204':
          description: Document trashed
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth 2.0 access token