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.taps.write.

Errors

  • WA-TCT-002: The Provider connection belongs to a different Workspace. Use a connection from the current Workspace.
  • WA-TCT-003: The requested Provider Tap was not found. Choose a Tap offered by the selected Provider connection.
  • WA-TCT-015: The Tap does not belong to the selected Provider connection. Select a Tap from the same Provider connection.
  • WA-TCT-006: A Tap with this name already exists on the connection. Choose a unique name or update the existing Tap.
  • WA-TCT-036: The Tap’s catalog tables get the same SQL name as another enabled Tap of this Provider in the Workspace. Rename or disable the other Tap, or change the schema that collides.
  • WA-TCT-035: The output schema changes the Provider Tap’s source permissions annotations. Keep every x-access* value as the Provider Tap declares it.

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

Create a per-workspace override of a platform tap. Required input is the source instance and the platform data pull. Everything else is optional and, when omitted, is copied from the platform ConnectorTap. Artifact-derived taps use publishArtifact.

connectorTapId
string
required

UUID v4 with automatic base62 encoding for client-facing APIs

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})$
tenantConnectorId
string
required

UUID v4 with automatic base62 encoding for client-facing APIs

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})$
tap
object

Optional fields shared by create (nested under tap) and update. Omitted create fields come from the platform ConnectorTap: name, description, and outputSchema copy the platform tap, enabled defaults to true, kind is OVERRIDE.

Response

Successful response

data
object
required

Per-workspace tap configuration. Either narrows a platform ConnectorTap's output schema for this workspace (override case) or stands in for an artifact-derived tap (artifact case). See for the model.

meta
object
required