APIs
APIs (API Schemas) let you import an OpenAPI 3.0 / 3.1 document into the workspace. Each operation becomes a callable tool for agents and workflows. You set a base URL and shared auth once on the schema.
Use them when you already have a REST API description and want the model to call those endpoints without writing custom glue for every path.
When to use
- Attach REST operations from an existing OpenAPI spec as agent tools
- Centralize token, API key, basic, or OAuth credentials for many endpoints
- Expose selected operations on a workspace MCP Server
Add an API schema
Open Integrations → APIs and choose Add Schema. A wizard opens on the same page.
- Choose Import URL or Paste schema.
- Enter the OpenAPI JSON URL, or paste the OpenAPI JSON.
- Confirm Name and Description (filled from the document). Set Base URL if it was not inferred from
servers. - Choose Auth (None, Token, Api Key, Basic, or OAuth).
- Review the operations, then Create. The schema detail page opens.
The detail page is read-only. Edit on the name card changes the display name and description. Edit on Connection opens a dialog for base URL, auth, and the OpenAPI document. Activity shows outbound calls when agents or MCP use this schema. Changing the schema is also recorded in the workspace audit log.
OAuth can be authorized from the details card after create (Authorize).
Auth options
| Auth | What you configure |
|---|---|
| None | No credentials |
| Token | Token value (literal or env.*), type Bearer / Basic / Custom (optional header name) |
| Api Key | Key value, location (Header / Query / Cookie), and parameter name |
| Basic | Username and password |
| OAuth | Save the schema first, then complete authorization in the popup |
Prefer storing secrets as environment variables and referencing them as env.MY_KEY instead of pasting tokens into the schema.
Limits
- Base URL must be a valid non-loopback
https://URL. - Hard delete removes the schema and its agent tool bindings — it does not appear in Trash.
- OAuth schemas need a successful save (the create wizard already does this) before you can authorize.
Details and activity
Open a schema from the list to see Setup and Activity.
| Tab | What you see |
|---|---|
| Setup | Name, description, base URL, auth type (not secret values), OpenAPI version, and the operation list. Name/description and connection (base URL, auth, schema) each have their own Edit dialog. |
| Activity | Outbound operation calls (method, path, status). Request and response bodies are not stored. Schema create/update/delete stays in the audit log. |
Where APIs are used
| Place | How |
|---|---|
| Agents / workflows | Tools per OpenAPI operation |
| MCP Servers | apiOperations (schemaId:operationId) |