Sign in

v2

latestOpenAPI 3.1.02026-07-262937191.0 MB
beta.connectors

Create a new connector.

Create a new MCP connector. You can customize its visibility, url and auth type.

post/v1/connectors

Request body

namestring required

The name of the connector. Should be 64 char length maximum, alphanumeric, only underscores/dashes.

titlestring nullable

Optional human-readable title for the connector.

descriptionstring required

The description of the connector.

icon_urlstring nullable

The optional url of the icon you want to associate to the connector.

visibility'shared_org' | 'shared_workspace' | 'private'

Visibility options available to public API callers.

Excludes shared_global which is reserved for system-owned connectors.

serverstring uri required

The url of the MCP server.

headersobject nullable

Optional organization-level headers to be sent with the request to the mcp server.

oauth2_server_metadata_urlstring uri nullable

Optional URL to fetch OAuth2 authorization server metadata from (RFC 8414). When provided, the metadata is fetched from this URL and used instead of .well-known discovery. Mutually exclusive with oauth2_server_metadata.

system_promptstring nullable

Optional system prompt for the connector.

Response

Successful Response

idstring uuid required
namestring required
titlestring nullable
descriptionstring required
created_atstring date-time required
modified_atstring date-time required
serverstring nullable
protocol'mcp' | 'http' | 'turbine'
icon_urlstring nullable
owner_idstring nullable
owner_type1 | 2 | 3 | 4 required
visibility'shared_global' | 'shared_org' | 'shared_workspace' | 'private' required
creator_idstring nullable
system_promptstring nullable
activeboolean nullable
private_tool_executionboolean required
mistralboolean
is_authenticatedboolean nullable
system_prompt_routestring nullable