Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Active Sessions API

4 actions 4 updates phrasing extends openapi/clerk-com-active-sessions-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['/v1/me/sessions/active'].get
$.paths['/v1/me/sessions/{session_id}/revoke'].post
$.paths['/v1/me/sessions'].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 Frontend Active Sessions API
  version: 1.0.0
extends: openapi/clerk-com-active-sessions-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['/v1/me/sessions/active'].get
  update:
    x-apievangelist-phrasing:
      intent: List my active sessions with activity
      effect: read
      questions:
      - Which devices am I currently signed in on, with their recent activity?
      - How do I show a user their active sessions only?
      instructions:
      - text: List my active sessions with device activity.
      - text: Show only the currently active sessions for my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/sessions/{session_id}/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign out one of my sessions
      effect: destructive
      questions:
      - How do I sign myself out of a device I no longer use?
      - Can a user revoke one of their own sessions remotely?
      instructions:
      - text: Revoke my session {session_id}.
        slots:
          session_id: path.session_id
      - text: Sign out the device with session {session_id}.
        slots:
          session_id: path.session_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/me/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List all my sessions
      effect: read
      questions:
      - How do I get every session of the current user, not just active ones?
      - What sessions exist on my account overall?
      instructions:
      - text: List all of my sessions, including ended ones.
      - text: Show every session on the signed-in user's account.
      method: generated
      generated: '2026-09-26'