Lucid · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lucid REST Legal Holds API

9 actions 9 updates phrasing extends openapi/lucid-legal-holds-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 9

$.info
$.paths['/v1/accounts/me/legalHolds'].get
$.paths['/v1/accounts/me/legalHolds'].post
$.paths['/v1/accounts/me/legalHolds/{legalHoldId}/users/add'].post
$.paths['/v1/accounts/me/legalHolds/{legalHoldId}/users/remove'].post
$.paths['/v1/accounts/me/legalHolds/{legalHoldId}'].patch
$.paths['/v1/accounts/me/legalHolds/{legalHoldId}/release'].post
$.paths['/v1/accounts/me/legalHolds/{legalHoldId}/users'].get
$.paths['/v1/accounts/me/legalHoldDocuments/{legalHoldId}'].get

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 Legal Holds API
  version: 1.0.0
extends: openapi/lucid-legal-holds-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: 8
- target: $.paths['/v1/accounts/me/legalHolds'].get
  update:
    x-apievangelist-phrasing:
      intent: List the account's legal holds
      effect: read
      questions:
      - Which legal holds are configured on our Lucid account?
      - Can I see every legal hold we've set up for eDiscovery?
      instructions:
      - text: List all legal holds on my account.
      - text: Show me our configured legal holds.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/me/legalHolds'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a legal hold
      effect: write
      questions:
      - How do I put a legal hold in place on an Enterprise Shield account?
      - Can a legal hold be limited to a time window and specific keywords?
      instructions:
      - text: Create legal hold {Title} from {StartTime} to {EndTime}.
        slots:
          Title: requestBody.Title
          StartTime: requestBody.StartTime
          EndTime: requestBody.EndTime
      - text: Create legal hold {Title} for {StartTime} to {EndTime} matching keywords {Keywords}.
        slots:
          Title: requestBody.Title
          StartTime: requestBody.StartTime
          EndTime: requestBody.EndTime
          Keywords: requestBody.Keywords
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/me/legalHolds/{legalHoldId}/users/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add users to a legal hold
      effect: write
      questions:
      - Can I add custodians to a legal hold that hasn't started yet?
      - What's the way to place more users under an upcoming legal hold?
      instructions:
      - text: Add users {Users} to legal hold {legalHoldId}.
        slots:
          Users: requestBody.Users
          legalHoldId: path.legalHoldId
      - text: Put {Users} under legal hold {legalHoldId}.
        slots:
          Users: requestBody.Users
          legalHoldId: path.legalHoldId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/me/legalHolds/{legalHoldId}/users/remove'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove users from a legal hold
      effect: destructive
      questions:
      - Can I take a user off a legal hold before it begins?
      - Is it possible to drop custodians from a legal hold once it has started?
      instructions:
      - text: Remove users {Users} from legal hold {legalHoldId}.
        slots:
          Users: requestBody.Users
          legalHoldId: path.legalHoldId
      - text: Take {Users} off legal hold {legalHoldId}.
        slots:
          Users: requestBody.Users
          legalHoldId: path.legalHoldId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/me/legalHolds/{legalHoldId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a legal hold's details or dates
      effect: write
      questions:
      - Can I extend the end time of an existing legal hold?
      - Which fields of a legal hold can still change after it has started?
      instructions:
      - text: Change the end time of legal hold {legalHoldId} to {EndTime}.
        slots:
          legalHoldId: path.legalHoldId
          EndTime: requestBody.EndTime
      - text: Retitle legal hold {legalHoldId} to {Title} and set description {Description}.
        slots:
          legalHoldId: path.legalHoldId
          Title: requestBody.Title
          Description: requestBody.Description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/me/legalHolds/{legalHoldId}/release'].post
  update:
    x-apievangelist-phrasing:
      intent: Release a legal hold
      effect: destructive
      questions:
      - How do I lift a legal hold once the matter is closed?
      - How long until documents are freed after a legal hold is released?
      instructions:
      - text: Release legal hold {legalHoldId}.
        slots:
          legalHoldId: path.legalHoldId
      - text: Lift legal hold {legalHoldId} so its documents are no longer restricted.
        slots:
          legalHoldId: path.legalHoldId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/me/legalHolds/{legalHoldId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users on a legal hold
      effect: read
      questions:
      - Which users are custodians under a given legal hold?
      - Can I see who has been placed on this legal hold?
      instructions:
      - text: List the users on legal hold {legalHoldId}.
        slots:
          legalHoldId: path.legalHoldId
      - text: Show custodians for legal hold {legalHoldId}.
        slots:
          legalHoldId: path.legalHoldId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/accounts/me/legalHoldDocuments/{legalHoldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List documents preserved by a legal hold
      effect: read
      questions:
      - Which documents are being preserved under a legal hold?
      - Why do documents still appear on a hold after I removed their owner?
      instructions:
      - text: List documents held by legal hold {legalHoldId}.
        slots:
          legalHoldId: path.legalHoldId
      - text: Show every document preserved under legal hold {legalHoldId}.
        slots:
          legalHoldId: path.legalHoldId
      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-legal-holds-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.

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