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.parables.manage.

Errors

  • PA-AU-001: The Parable or the Report run was not found in this Workspace. Check the rootRefId and reportRunId.
  • PA-AU-019: The caller cannot cancel a Report run of this Parable. Use a Workspace identity with Parable manage permission and the required RACI role.
  • PA-AU-005: The Report run already finished, or it runs on the legacy Report worker, so it cannot be cancelled. Read the Report context; only a run that is still moving can be cancelled.

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

reportRunId
string
required

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

Response

Successful response

data
object
required

One reading, and the version it read. publishedCommitId is never a version string such as v2.3. Read the version's number from the published commit.

meta
object
required