Skip to main content
POST
TypeScript SDK

Publish an Artifact as a data source

publish_artifact

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

Input for publishing a artifact as a provider connection. The artifact must be READY with a non-null dataSchema. Publish creates a fresh TenantConnectorTap whose outputSchema is a snapshot copy of artifact.dataSchema at publish time; the two diverge thereafter. Optional name overrides the auto-derived {slug(filename)}-{first 8 hex of artifactId} default; on a unique-index collision the request returns NAME_ALREADY_EXISTS. tableName becomes the table's name in the data catalog, and SQL reads the published data under it. It is also stored as the artifact catalogSlug / table identity on the published ARTIFACT tap.

artifactId
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})$
requestId
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})$
tableName
string
required

A URL friendly version of a string

Required string length: 1 - 255
Pattern: ^[a-z0-9]+(?:[-_][a-z0-9]+)*$
description
string | null
name
string | null

An objects name

Required string length: 2 - 80

Response

Successful response

data
object
required
meta
object
required