Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Backend Sign-in Tokens API

3 actions 3 updates phrasing extends openapi/clerk-com-sign-in-tokens-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 3

$.info

$.paths['/sign_in_tokens'].post

$.paths['/sign_in_tokens/{sign_in_token_id}/revoke'].post

OpenAPI Overlay

# 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 Sign-in Tokens API
  version: 1.0.0
extends: openapi/clerk-com-sign-in-tokens-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: 2
- target: $.paths['/sign_in_tokens'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sign-in token for a user
      effect: write
      questions:
      - How do I generate a magic sign-in link for a user from my backend?
      - How long does a sign-in token last, and can I shorten it?
      instructions:
      - text: Create a sign-in token for user {user_id}.
        slots:
          user_id: requestBody.user_id
      - text: Issue a sign-in token for {user_id} that expires in {expires_in_seconds} seconds.
        slots:
          user_id: requestBody.user_id
          expires_in_seconds: requestBody.expires_in_seconds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sign_in_tokens/{sign_in_token_id}/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a sign-in token
      effect: destructive
      questions:
      - How do I invalidate a sign-in token before it's used?
      - Can a sign-in token that was already used be revoked?
      instructions:
      - text: Revoke sign-in token {sign_in_token_id}.
        slots:
          sign_in_token_id: path.sign_in_token_id
      - text: Cancel the pending sign-in token {sign_in_token_id}.
        slots:
          sign_in_token_id: path.sign_in_token_id
      method: generated
      generated: '2026-09-26'