Lucid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lucid REST Embedding Utils API

6 actions 6 updates phrasing extends openapi/lucid-embedding-utils-api-openapi.yml
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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/v1/documents/{documentId}/embeds/{embedId}'].get
$.paths['/v1/documents/{documentId}/embeds/{embedId}'].delete
$.paths['/v1/documents/{documentId}/embeds/{embedId}/document'].get
$.paths['/v1/documents/{id}/embeds'].post
$.paths['/v1/documents/{documentId}/embeds/{embedId}/changeVersion'].post

OpenAPI Overlay

Raw ↑ 
# 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 Embedding Utils API
  version: 1.0.0
extends: openapi/lucid-embedding-utils-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: 5
- target: $.paths['/v1/documents/{documentId}/embeds/{embedId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document embed's details
      effect: read
      questions:
      - What metadata can I get about an existing document embed?
      - Does a snapshot embed report the document as it was when the snapshot was taken?
      instructions:
      - text: Get embed {embedId} on document {documentId}.
        slots:
          embedId: path.embedId
          documentId: path.documentId
      - text: Show the settings of embed {embedId} for document {documentId}.
        slots:
          embedId: path.embedId
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{documentId}/embeds/{embedId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a document embed
      effect: destructive
      questions:
      - Can I remove an embed so it stops loading in the viewer?
      - What happens to the viewer after a document embed is deleted?
      instructions:
      - text: Delete embed {embedId} from document {documentId}.
        slots:
          embedId: path.embedId
          documentId: path.documentId
      - text: Remove document {documentId}'s embed {embedId}.
        slots:
          documentId: path.documentId
          embedId: path.embedId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{documentId}/embeds/{embedId}/document'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the document behind an embed
      effect: read
      questions:
      - Which document is shown by a given embed?
      - Can I read the embedded document's title through the embed?
      instructions:
      - text: Get the document behind embed {embedId} on {documentId}.
        slots:
          embedId: path.embedId
          documentId: path.documentId
      - text: Show the embedded document metadata for embed {embedId} of document {documentId}.
        slots:
          embedId: path.embedId
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{id}/embeds'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an embed for a document
      effect: write
      questions:
      - How do I create an embed so a document can be shown in my app?
      - Can I choose between a live or snapshot version when embedding a document?
      instructions:
      - text: Create a {embedVersion} embed for document {id}.
        slots:
          embedVersion: requestBody.embedVersion
          id: path.id
      - text: Embed document {id} using version type {embedVersion}.
        slots:
          id: path.id
          embedVersion: requestBody.embedVersion
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/documents/{documentId}/embeds/{embedId}/changeVersion'].post
  update:
    x-apievangelist-phrasing:
      intent: Switch an embed's version type
      effect: write
      questions:
      - Can I freeze an existing embed to a snapshot of the document?
      - Is changing an embed to snapshot-version reversible?
      instructions:
      - text: Change embed {embedId} on document {documentId} to {embedVersion}.
        slots:
          embedId: path.embedId
          documentId: path.documentId
          embedVersion: requestBody.embedVersion
      - text: Freeze embed {embedId} of document {documentId} as {embedVersion}.
        slots:
          embedId: path.embedId
          documentId: path.documentId
          embedVersion: requestBody.embedVersion
      method: generated
      generated: '2026-10-01'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay 
curl "https://apis.io/api/v1/overlays/lucid-embedding-utils-api-phrasing-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.