Concepts
The core objects in OpenAPI Studio — workspaces, specs, roles, hotlinks, profiles.
Everything you do in OpenAPI Studio fits into a small handful of objects. Once these click, the rest of the product makes sense.
Workspace
A workspace is the unit of collaboration. It owns:
- A list of specs.
- A member list with roles.
- Stored credentials for security schemes (API keys, bearer tokens).
- Shared header profiles (reusable HTTP header sets).
- Connected integrations (Slack, GitHub, Linear, Notion).
One workspace per project is typical. You can have as many as you need; each is fully isolated.
Spec
A spec is an OpenAPI 3.0 / 3.1 document. Everything you edit in the flow builder, run from the executor, or expose via a hotlink lives inside one spec.
The spec is the single source of truth — every view (flow, table, docs, runner, export) is derived from it.
Roles
Three roles per workspace:
| Role | Edit specs | Run requests | Manage members | Manage workspace |
|---|---|---|---|---|
| Owner | Yes | Yes | Yes | Yes |
| Editor | Yes | Yes | No | No |
| Viewer | No | Yes | No | No |
The workspace owner is whoever created it; ownership can be transferred from settings.
Hotlink
A hotlink is a public URL that serves your spec as JSON or YAML, edge-cached on Cloudflare’s network. Useful for:
- Pointing client SDK generators at the latest spec.
- Embedding into Swagger UI / Redoc / Stoplight.
- Sharing with external partners without giving them an account.
Hotlinks are off by default. Enable per-spec from spec settings.
Header profile
A header profile is a named set of HTTP headers (and their values) that you can attach when running requests — Authorization, X-Request-Id, custom auth, anything. Profiles can be:
- Personal — only you see them.
- Workspace — shared with the team.
- Shared — superadmin-managed, available across all workspaces (e.g. a corporate proxy header).
You stack profiles when running a request — top of the stack wins.
Execution history
Every request you run is captured in execution history for 7 days. You can save important runs to keep them past the retention window. History is per-spec.
Recipe
A recipe is a multi-step automated test. Each step is an HTTP call with assertions on status, headers, body fields, and timing. Recipes can pass values from one step’s response into the next step’s request via variables.
Integrations
Workspaces can connect to external tools via OAuth:
- GitHub — push your spec to a repo on demand.
- Slack — get notifications on spec changes, recipe failures, breaking changes.
- Linear / Notion — file issues / docs from inside the editor.
- MCP — expose your spec to AI assistants (Claude, Cursor, Continue) as a Model Context Protocol server.
See Integrations.
Extension
An extension is an optional capability available from the marketplace. Some extensions are free; others are billable. Examples include AI Coach (in-editor LLM assistance) and proprietary connectors. Manage extensions per-workspace from settings.