Skip to main content
POST
Create Connection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

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.

base_url
string
required

Base URL for API requests, e.g. 'https://api.example.com'.

Maximum string length: 500
name
string
required

Display name for the connection (unique per workspace).

Required string length: 1 - 255
auth_config_id
string<uuid> | null

Optional MCPAuthConfig UUID for OAuth2 token rotation. When set, tokens are minted/refreshed on the connection's behalf.

custom_headers
HeaderInput · object[] | null

Custom HTTP headers attached to every request. Non-safe headers (e.g. Authorization) are stored encrypted in the secret manager.

description
string | null

Optional human-readable summary of what this API exposes.

spec_content
Spec Content · object | null

Inline OpenAPI 3.x spec as a JSON object. Use instead of spec_url when the spec host is unreachable from the API.

spec_url
string | null

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.

Response

Successful Response

base_url
string
required
created_at
any
required
id
string<uuid>
required
name
string
required
status
string
required
updated_at
any
required
auth_config_id
string<uuid> | null
available_tools
Available Tools · object[]
custom_headers
HeaderOutput · object[] | null
description
string | null
spec_url
string | null