Skip to main content
POST
Python SDK

Access

An MCP token or a Parable token can call this operation. See Authentication for the kinds of token. Your roles must grant tenant.data.catalog.

Errors

  • HTTP 404: No table of that name is in a Pool the caller may read. The name may be misspelled, or the table may be in a Pool their role does not reach. Copy tableRef from a search result.
  • HTTP 403: The caller cannot read the Workspace data catalog. Use an identity with data catalog permission.

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
tableRef
string
required

The table's name as a FROM clause takes it, such as providers.jiracloud.issues. Search results return it as tableRef.

Required string length: 1 - 500

Response

Successful response

data
object
required

One table of the catalog, as Parable describes it: its fields with their Arrow types and Parable scalars, its primary key and relationships, and what is known of its rows and freshness. A value no measurement has produced is null, which means unknown, not healthy.

meta
object
required