Create a contract
From blank page to a published, governed contract in six steps — with an AI assistant trained specifically for API contracts riding along the whole way. The wizard walks Define → Compose → Schema → Publishing → Governance → Review, and you can save a draft at any step and come back later.
1
Define: name it and pick your audience
Give the contract a name and an optional description, then answer the question that shapes everything else: who is this contract for? Choose Partner Integration, Internal Service, Public API, or AI Agent / MCP. Each card states its defaults up front — visibility, whether publishing requires approval, and which artifacts it produces — so the governance conversation happens at minute one, not after launch.
2
Compose: select collections and endpoints
Cherry-pick the contract's surface from your live catalog. Collections expand into their tag groups and method-labeled endpoints, each with a checkbox — check a whole collection, a tag group, or a single DELETE /api/v1/cart/:itemId. Filter by repo or tag, search across everything, or select all. A running footer keeps the count honest: 2 collections · 32 endpoints total.
A contract is not one-to-one with a collection. Pull the four partner-relevant endpoints from Billing, two from Users, and one webhook from Integrations — the contract is the curated union.
3
Schema: control field-level exposure
For every selected endpoint, decide which fields it exposes: toggle fields on or off, mark them required or optional, and add constraints. PII and internal-only fields arrive pre-flagged, and one-click actions like Exclude PII trim entire categories at once. The full breakdown lives on the field-level exposure page.
4
Publishing: choose the artifacts
Decide where the contract materializes: the hosted OpenAPI spec, documentation platforms, an auto-generated MCP server that exposes only contract endpoints, TypeScript and Python SDKs, a Postman collection, and CI/CD hooks like GitHub PR comments.
5
Governance: set the rules and the people
Pick a breaking-change policy (block publish, warn and require acknowledgment, or notify only), describe validation rules in plain language, and invite stakeholders by email with a role — Approver, Reviewer, or Consumer.
6
Review: read the promise before you make it
A final pass over everything you configured — audience, endpoints, exposed fields, targets, and governance — before the contract is created and versioned.
The AI assistant is a co-author, not a chatbot
Every step of the wizard carries an assistant panel that is, in its own words, “specially trained for API contracts” — and it does real work:
- Start from a prompt. On the early steps, tell it what your API should do and it helps you structure the contract — there is a one-click Create an API contract from a prompt shortcut.
- Fine-tune the schema. On the Schema step it can mark fields as required, edit field properties, update descriptions, and modify schemas. You type “make email required everywhere and drop every internal field” — it does the clicking.
The wizard's order is deliberate: audience before endpoints, endpoints before fields, fields before publishing. By the time anything ships, every exposure decision has already been made once, on purpose, by you.
Where to go next
Field-level exposure & PII
The Schema step in depth: per-field toggles, PII and internal flags, and the exposure tally.
Publishing targets
Spec, docs, MCP, SDKs, Postman, and CI/CD — everything a contract can generate.
On this page
- Create a contract