Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Backend Miscellaneous API

2 actions 2 updates phrasing extends openapi/clerk-com-miscellaneous-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 2

$.info

$.paths['/public/interstitial'].get

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 Miscellaneous API
  version: 1.0.0
extends: openapi/clerk-com-miscellaneous-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: 1
- target: $.paths['/public/interstitial'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the interstitial page markup
      effect: read
      questions:
      - What is the interstitial page SDKs load when auth state is unknown?
      - Can I render the interstitial with a proxy URL or custom domain?
      instructions:
      - text: Get the interstitial page for publishable key {publishable_key}.
        slots:
          publishable_key: query.publishable_key
      - text: Fetch interstitial markup with proxy URL {proxy_url} and sign-in URL {sign_in_url}.
        slots:
          proxy_url: query.proxy_url
          sign_in_url: query.sign_in_url
      method: generated
      generated: '2026-09-26'