Generated by API Evangelist
Written by API Evangelist tooling for Lucid's API. It is a proposal applied on top of the contract, not a document Lucid publishes.
# 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 Comments API
version: 1.0.0
extends: openapi/lucid-document-comments-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: 3
- target: $.paths['/v1/documents/{documentId}/threads'].get
update:
x-apievangelist-phrasing:
intent: List comment threads on a document
effect: read
questions:
- Which comment threads are open or closed on a Lucid document?
- Can I see all discussion threads on a diagram?
instructions:
- text: List comment threads on document {documentId}.
slots:
documentId: path.documentId
- text: Show open and closed threads for document {documentId}.
slots:
documentId: path.documentId
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/documents/{documentId}/threads/{threadId}/comments'].get
update:
x-apievangelist-phrasing:
intent: Read the comments in a thread
effect: read
questions:
- What comments have people left in a specific thread?
- Who wrote each comment in this thread and who is assigned?
instructions:
- text: List the comments in thread {threadId} on document {documentId}.
slots:
threadId: path.threadId
documentId: path.documentId
- text: Read thread {threadId} of document {documentId}.
slots:
threadId: path.threadId
documentId: path.documentId
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/documents/{documentId}/threads/{threadId}/comments'].post
update:
x-apievangelist-phrasing:
intent: Reply to a comment thread
effect: write
questions:
- How do I add a reply to an existing comment thread on a document?
- Is there a length limit on comments I post?
instructions:
- text: Reply {comment} in thread {threadId} on document {documentId}.
slots:
comment: requestBody.comment
threadId: path.threadId
documentId: path.documentId
- text: Post comment {comment} to thread {threadId} of document {documentId}.
slots:
comment: requestBody.comment
threadId: path.threadId
documentId: path.documentId
method: generated
generated: '2026-10-01'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.