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.
# 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 Beta Features API
version: 1.0.0
extends: openapi/clerk-com-beta-features-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['/beta_features/instance_settings'].patch
update:
x-apievangelist-phrasing:
intent: Update instance restrictions and test mode
effect: write
questions:
- How do I restrict sign-ups on my instance to the allowlist?
- Can I turn on test mode or progressive sign-up for an instance?
instructions:
- text: Restrict my instance to the allowlist ({restricted_to_allowlist}).
slots:
restricted_to_allowlist: requestBody.restricted_to_allowlist
- text: Set test mode to {test_mode} and progressive sign-up to {progressive_sign_up}.
slots:
test_mode: requestBody.test_mode
progressive_sign_up: requestBody.progressive_sign_up
method: generated
generated: '2026-09-26'
- target: $.paths['/beta_features/domain'].put
update:
x-apievangelist-phrasing:
intent: Change the production domain (beta endpoint)
effect: write
questions:
- How do I move my production instance to a new domain using the beta_features domain endpoint?
- Is there an older beta PUT endpoint for changing the production domain?
instructions:
- text: Using the beta domain endpoint, change my production domain to {home_url}.
slots:
home_url: requestBody.home_url
- text: PUT the beta production domain to {home_url} as secondary ({is_secondary}).
slots:
home_url: requestBody.home_url
is_secondary: requestBody.is_secondary
method: generated
generated: '2026-09-26'
- target: $.paths['/instance/change_domain'].post
update:
x-apievangelist-phrasing:
intent: Change the production domain (instance endpoint)
effect: write
questions:
- How do I change my production instance's domain with the instance change_domain endpoint?
- What DNS and SSL work follows a production domain change?
instructions:
- text: Change my production instance domain to {home_url} via instance change_domain.
slots:
home_url: requestBody.home_url
- text: Use change_domain to set {home_url} as the production domain, secondary {is_secondary}.
slots:
home_url: requestBody.home_url
is_secondary: requestBody.is_secondary
method: generated
generated: '2026-09-26'
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.