Payload for creating an OpenAPI connection.
The connection ties a base URL (where requests are sent) to an OpenAPI 3.x specification (which is parsed eagerly into a tool list). Provide either spec_url or spec_content — not both required.
Optional MCPAuthConfig UUID for OAuth2 token rotation. When set, tokens are minted/refreshed on the connection's behalf.
Base URL for API requests, e.g. 'https://api.example.com'.
Custom HTTP headers attached to every request. Non-safe headers (e.g. Authorization) are stored encrypted in the secret manager.
Optional human-readable summary of what this API exposes.
Display name for the connection (unique per workspace).
Inline OpenAPI 3.x spec as a JSON object. Use instead of spec_url when the spec host is unreachable from the API.
URL to an OpenAPI 3.x JSON or YAML spec. The spec is fetched and parsed eagerly at create time so the connection is ready for use.
Successful Response