API Evangelist conversational phrasing for Lucid REST Document Access API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lucid REST Document Access API
  version: 1.0.0
extends: openapi/lucid-document-access-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/v1/accounts/me/documents/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search all documents across the account as admin
      effect: read
      questions:
      - How can an admin find every document on our Enterprise Shield account?
      - Can I search account-wide documents by classification or external access?
      - What is the rate limit for searching all account documents?
      instructions:
      - text: As {Lucid-Request-As}, search all account documents for keywords {keywords}.
        slots:
          Lucid-Request-As: header.Lucid-Request-As
          keywords: requestBody.keywords
      - text: Find account documents owned by users {ownedByUsers}, requesting as {Lucid-Request-As}.
        slots:
          ownedByUsers: requestBody.ownedByUsers
          Lucid-Request-As: header.Lucid-Request-As
      - text: List account documents with classification {classificationIds}, requesting as {Lucid-Request-As}.
        slots:
          classificationIds: requestBody.classificationIds
          Lucid-Request-As: header.Lucid-Request-As
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new Lucidchart or Lucidspark document
      effect: write
      questions:
      - How do I create a blank Lucidchart diagram from code?
      - Can I create a new document already filled with shapes in Standard Import format?
      instructions:
      - text: Create a {product} document titled {title}.
        slots:
          product: requestBody.product
          title: requestBody.title
      - text: Create a {product} document called {title} in folder {parent}.
        slots:
          product: requestBody.product
          title: requestBody.title
          parent: requestBody.parent
      - text: Create a {product} document titled {title} with content {content}.
        slots:
          product: requestBody.product
          title: requestBody.title
          content: requestBody.content
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/create'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a document from a Standard Import zip
      effect: write
      questions:
      - Can I upload a Lucid Standard Import .zip file to make a new document?
      - What title does a document get when I create it from an uploaded Standard Import archive?
      instructions:
      - text: Create a {product} document from the Standard Import archive {file} of type {type}.
        slots:
          product: requestBody.product
          file: requestBody.file
          type: requestBody.type
      - text: Upload Standard Import zip {file} as a {product} document titled {title}.
        slots:
          file: requestBody.file
          product: requestBody.product
          title: requestBody.title
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import an external file as a document
      effect: write
      questions:
      - How do I import a draw.io file into Lucidchart?
      - Which non-Lucid file types can I convert into a new document?
      instructions:
      - text: Import file {file} of type {type} as a {product} document.
        slots:
          file: requestBody.file
          type: requestBody.type
          product: requestBody.product
      - text: Import external diagram {file} ({type}) into {product} in folder {parent}.
        slots:
          file: requestBody.file
          type: requestBody.type
          product: requestBody.product
          parent: requestBody.parent
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/copy'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy an existing document
      effect: write
      questions:
      - Can I duplicate one of my documents under a new name?
      - Do collaborators carry over when I copy a document?
      instructions:
      - text: Copy document {template} as {title}.
        slots:
          template: requestBody.template
          title: requestBody.title
      - text: Duplicate document {template} into folder {parent} named {title}.
        slots:
          template: requestBody.template
          parent: requestBody.parent
          title: requestBody.title
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get document details or export it as an image
      effect: read
      questions:
      - How do I export a Lucid document page as a PNG?
      - What metadata can I get about a document, such as its owner?
      - Can I crop an exported page or pick which page to export?
      instructions:
      - text: Get the details of document {id}.
        slots:
          id: path.id
      - text: Export page {page} of document {id} as {Accept}.
        slots:
          page: query.page
          id: path.id
          Accept: header.Accept
      - text: Export document {id} as an image cropped to {crop}.
        slots:
          id: path.id
          crop: query.crop
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename, move or reclassify a document
      effect: write
      questions:
      - How do I rename a document or move it to another folder?
      - Can I change a document's classification or custom tags?
      instructions:
      - text: Rename document {id} to {title}.
        slots:
          id: path.id
          title: requestBody.title
      - text: Move document {id} into folder {parent}.
        slots:
          id: path.id
          parent: requestBody.parent
      - text: Set classification {classificationId} on document {id}.
        slots:
          classificationId: requestBody.classificationId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{id}/trash'].post
  update:
    x-apievangelist-phrasing:
      intent: Move a document to the trash
      effect: destructive
      questions:
      - Can I trash a document I own?
      - Will others still see a shared document after I trash it?
      instructions:
      - text: Trash document {id}.
        slots:
          id: path.id
      - text: Send document {id} to my trash.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search my documents
      effect: read
      questions:
      - Which of my documents match a keyword?
      - Can I search my documents modified within a date range and exclude trashed ones?
      instructions:
      - text: Search my documents for {keywords}.
        slots:
          keywords: requestBody.keywords
      - text: Find my {product} documents modified after {lastModifiedAfter}.
        slots:
          product: requestBody.product
          lastModifiedAfter: requestBody.lastModifiedAfter
      - text: 'Search documents owned by {owners}, excluding trashed ones: {excludeTrashed}.'
        slots:
          owners: requestBody.owners
          excludeTrashed: requestBody.excludeTrashed
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{id}/contents'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the shapes and contents of a document
      effect: read
      questions:
      - What shapes, pages and text are inside a Lucidchart or Lucidspark board?
      - Is a document's contents output stable over time if nothing changed?
      instructions:
      - text: Read the contents of document {id}.
        slots:
          id: path.id
      - text: List the pages and shapes inside document {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'