AGagentarea
v1
protected
openapi-connections

Create Connection

Changed on
post/v1/workspaces/{workspace}/openapi-connections/

Request

Path parameters

workspacestring required

Slug of the workspace the request acts in

Request body

auth_config_idstring uuid nullable

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

base_urlstring required

Base URL for API requests, e.g. 'https://api.example.com'. The path may hold '{name}' placeholders filled from url_variables, e.g. 'https://api.telegram.org/bot{token}'.

descriptionstring nullable

Optional human-readable summary of what this API exposes.

namestring required

Display name for the connection (unique per workspace).

spec_contentobject nullable

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

spec_urlstring nullable

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

auth_config_idstring uuid nullable
base_urlstring nullable required
costobject nullable
created_atstring date-time required
descriptionstring nullable
idstring uuid required
is_ownerboolean
last_dispatchobject nullable
managed_bystring nullable
namestring required
personalboolean
registry_item_idstring uuid nullable
spec_urlstring nullable
statusstring required
updated_atstring date-time required
url_variablesstring[] nullable

Changes

  • 4662804c264bRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • e3fec4c019cbRevision changes
    • breaking

      response property base_url list-of-types was widened by adding types null to media type application/json of response 201