Generated by API Evangelist
Written by API Evangelist tooling for Auth0's API. It is a proposal applied on top of the contract, not a document Auth0 publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Auth0 Management Forms API
version: 1.0.0
extends: openapi/auth0-forms-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 5
- target: $.paths['/forms'].get
update:
x-apievangelist-phrasing:
intent: List Forms
effect: read
questions:
- Which Forms have I built for my login flows?
- Can I list Forms with their flows and nodes expanded?
instructions:
- text: List all my Forms.
- text: List Forms with {hydrate} hydrated.
slots:
hydrate: query.hydrate
method: generated
generated: '2026-10-01'
- target: $.paths['/forms'].post
update:
x-apievangelist-phrasing:
intent: Create a Form
effect: write
questions:
- How do I build a custom form to collect extra info during signup?
- Can I define a Form's nodes, languages and styling when creating it?
instructions:
- text: Create a Form named {name}.
slots:
name: requestBody.name
- text: Create Form {name} with nodes {nodes} and languages {languages}.
slots:
name: requestBody.name
nodes: requestBody.nodes
languages: requestBody.languages
method: generated
generated: '2026-10-01'
- target: $.paths['/forms/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a Form
effect: read
questions:
- What nodes and messages does a specific Form contain?
- Can I fetch one Form with its related objects hydrated?
instructions:
- text: Show me Form {id}.
slots:
id: path.id
- text: Get Form {id} with {hydrate} expanded.
slots:
id: path.id
hydrate: query.hydrate
method: generated
generated: '2026-10-01'
- target: $.paths['/forms/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a Form
effect: destructive
questions:
- How do I remove a Form I no longer use?
- Can I delete a Form by its ID?
instructions:
- text: Delete Form {id}.
slots:
id: path.id
- text: Remove the unused Form {id}.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/forms/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a Form
effect: write
questions:
- Can I change the styling of an existing Form?
- How do I add translations to a Form I already built?
instructions:
- text: Update the style of Form {id} to {style}.
slots:
id: path.id
style: requestBody.style
- text: Set the translations on Form {id} to {translations}.
slots:
id: path.id
translations: requestBody.translations
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.