Skip to main content
GET
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 one of tenant.parables.view, tenant.parables.manage.

Errors

  • PA-AU-040: The Plot contract or definition is not conforming. Refresh the selected definition and correct the Plot contract.
  • PA-AU-001: The Parable or Plot manifest was not found. Check the rootRefId and selected ref or Version.
  • PA-AU-019: The caller cannot inspect this Plot. Use a Workspace identity with Parable access and the required RACI role.

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"

Path Parameters

rootRefId
string
required

rootRefId parameter UUID v4 with automatic base62 encoding for client-facing APIs

Query Parameters

refId
string

UUID v4 with automatic base62 encoding for client-facing APIs

versionId
string

UUID v4 with automatic base62 encoding for client-facing APIs

Response

Successful response

data
object
required

A Parable's data contract: the Plots it serves and their columns. It holds no storage location, SQL or table path.

meta
object
required