Stax · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for stax-api Self API
7 actions
7 updates
phrasing
extends
openapi/stax-self-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Stax's API. It is a proposal applied on top of the contract, not a document Stax publishes.
What the actions change
x-apievangelist-phrasing
Targets 7
$.info
$.paths['/self/exists'].get
$.paths['/self'].get
$.paths['/self'].put
$.paths['/self'].post
$.paths['/self/verify/resend'].put
$.paths['/self/verify/{token}'].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 stax-api Self API
version: 1.0.0
extends: openapi/stax-self-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: 6
- target: $.paths['/self/exists'].get
update:
x-apievangelist-phrasing:
intent: Check whether an email is already registered
effect: read
questions:
- Is an email address already taken by an existing Stax user?
- Can I validate an email before signing someone up?
instructions:
- text: Check whether {email} already exists.
slots:
email: query.email
- text: Validate the email {email} before registration.
slots:
email: query.email
method: generated
generated: '2026-09-26'
- target: $.paths['/self'].get
update:
x-apievangelist-phrasing:
intent: Get my user and team info
effect: read
questions:
- Who am I logged in as, and which team am I on?
- Can I fetch the current user's profile along with their merchant team?
instructions:
- text: Show my user and team info.
- text: Get the profile of the currently authenticated user.
method: generated
generated: '2026-09-26'
- target: $.paths['/self'].put
update:
x-apievangelist-phrasing:
intent: Update my own user profile
effect: write
questions:
- Can I change my own name or details on my Stax login?
- Is it possible for a logged-in user to edit their own profile?
instructions:
- text: Update my own user profile.
- text: Save changes to the logged-in user's info.
method: generated
generated: '2026-09-26'
- target: $.paths['/self'].post
update:
x-apievangelist-phrasing:
intent: Self-register a new user account
effect: write
questions:
- How does someone sign up for their own user account?
- Can a new user register with a verification link pointing to my site?
instructions:
- text: Register a new user {name} with email {email}, password {password} and confirmation {password_confirmation}.
slots:
name: query.name
email: query.email
password: query.password
password_confirmation: query.password_confirmation
- text: Sign up {name} ({email}) with password {password}/{password_confirmation} and verification URL {url}.
slots:
name: query.name
email: query.email
password: query.password
password_confirmation: query.password_confirmation
url: query.url
method: generated
generated: '2026-09-26'
- target: $.paths['/self/verify/resend'].put
update:
x-apievangelist-phrasing:
intent: Resend the verification email
effect: write
questions:
- What if a new user never received their email verification message?
- Can I trigger the account verification email again?
instructions:
- text: Resend my verification email.
- text: Send the new-user email verification again.
method: generated
generated: '2026-09-26'
- target: $.paths['/self/verify/{token}'].get
update:
x-apievangelist-phrasing:
intent: Verify an email confirmation token
effect: read
questions:
- Is the token from a user's email verification link valid?
- Can I confirm a new user's email using the token they clicked?
instructions:
- text: Verify email token {token}.
slots:
token: path.token
- text: Check the email verification token {token} is valid.
slots:
token: path.token
method: generated
generated: '2026-09-26'
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/stax-self-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
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.
A second provider on the same verified email joins the account you already have.