Skip to main content
POST
Python SDK

Access

This operation needs a Parable token. An MCP token cannot call it. See Authentication for the kinds of token. Your roles must grant tenant.connectors.create.

Errors

  • HTTP 403: The person cannot add Provider connections in this Workspace. Ask someone who manages the Workspace’s Providers to connect it.
  • HTTP 404: No way of connecting to a Provider has this groupingId. Read the ways of connecting with list_ways_connecting_provider and use one of their ids.
  • WA-CN-005: The Provider is not released for Workspace enablement. Choose a released Provider.
  • WA-CN-013: This idempotencyKey already started a setup for another way of connecting. Send a new idempotencyKey.

Authorizations

Authorization
string
header
required

A personal access token, which starts with pat_. A Parable token can call each operation that the roles of its owner allow. An MCP token can call only the read operations that are open to agents. A SQL token does not work on this API.

Headers

X-Tenant
string

Workspace slug. Overrides subdomain-based workspace resolution when provided.

Example:

"acme"

X-Request-ID
string<uuid>

Optional request correlation ID echoed back in the response.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

Start a setup of one Provider connection that the person completes in the browser.

groupingId
string
required

The way of connecting to the Provider: an id that list_ways_connecting_provider gives.

Pattern: ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
idempotencyKey
string
required

The key of this call. The same key answers the same setup.

Pattern: ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

Successful response

data
object
required

One setup of a Provider connection in the browser. It holds no secret.

meta
object
required