Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Backend Clients API

4 actions 4 updates phrasing extends openapi/clerk-com-clients-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Clerk's API. It is a proposal applied on top of the contract, not a document Clerk publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/clients'].get
$.paths['/clients/verify'].post
$.paths['/clients/{client_id}'].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 Clerk Backend Clients API
  version: 1.0.0
extends: openapi/clerk-com-clients-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/clients'].get
  update:
    x-apievangelist-phrasing:
      intent: List all clients (deprecated)
      effect: read
      questions:
      - How do I list every client device record in my instance?
      - Is the list-all-clients endpoint being deprecated?
      instructions:
      - text: List all clients, newest first.
      - text: Show the first {limit} clients.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/clients/verify'].post
  update:
    x-apievangelist-phrasing:
      intent: Verify a client token
      effect: read
      questions:
      - How do I verify the client contained in a token on my backend?
      - Can I check that a client token is valid?
      instructions:
      - text: Verify the client in token {token}.
        slots:
          token: requestBody.token
      - text: Check that client token {token} is genuine.
        slots:
          token: requestBody.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/clients/{client_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a client's details
      effect: read
      questions:
      - How do I look up one client and its sessions by ID?
      - What details are returned for a single client?
      instructions:
      - text: Get client {client_id}.
        slots:
          client_id: path.client_id
      - text: Show the details of client {client_id}.
        slots:
          client_id: path.client_id
      method: generated
      generated: '2026-09-26'