Python SDK
import os
from parable_web_api_sdk import ClientConfig, WebApiSDK
sdk = WebApiSDK(
ClientConfig(
base_url=os.environ["PARABLE_API_URL"],
auth_token=os.environ["PARABLE_API_TOKEN"],
default_headers={"X-Tenant": os.environ["PARABLE_WORKSPACE"]},
)
)
result = sdk.parable_authoring.get_parable_plot_data_manifest('example', ref_id=None, version_id=None)sdk, err := webapisdk.New(webapisdk.SDKConfig{
BaseURL: os.Getenv("PARABLE_API_URL"),
Auth: &webapisdk.AuthConfig{Token: os.Getenv("PARABLE_API_TOKEN")},
RequestInterceptor: func(ctx context.Context, req *http.Request) error {
req.Header.Set("X-Tenant", os.Getenv("PARABLE_WORKSPACE"))
return nil
},
})
if err != nil {
return err
}
query := &namespaces.ParableAuthoringGetParablePlotDataManifestQueryParams{}
result, err := sdk.ParableAuthoringNamespace.GetParablePlotDataManifest(ctx, "example", query){
"data": {
"contractVersion": "<string>",
"parable": {
"entityKey": "<string>",
"slug": "<string>"
},
"plots": [
{
"columns": [
{
"name": "<string>",
"primitive": "<string>",
"sortable": true,
"scalarRef": "<string>"
}
],
"entityKey": "<string>",
"handle": "<string>",
"requiresReportingRun": true,
"schemaStatus": "AVAILABLE",
"slug": "<string>",
"outputSchemaUpdatedAt": "2023-11-07T05:31:56Z",
"unavailableReason": "<string>"
}
],
"ref": "<string>"
},
"meta": {
"requestId": "<string>",
"totalCount": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
}
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}List what a Plot will return
Lists the outputs a Plot produces and the columns each one is planned to have. The SQL behind it is not returned.
GET
/
api
/
parable
/
authoring
/
primaries
/
{rootRefId}
/
plots
/
data
/
manifest
Python SDK
import os
from parable_web_api_sdk import ClientConfig, WebApiSDK
sdk = WebApiSDK(
ClientConfig(
base_url=os.environ["PARABLE_API_URL"],
auth_token=os.environ["PARABLE_API_TOKEN"],
default_headers={"X-Tenant": os.environ["PARABLE_WORKSPACE"]},
)
)
result = sdk.parable_authoring.get_parable_plot_data_manifest('example', ref_id=None, version_id=None)sdk, err := webapisdk.New(webapisdk.SDKConfig{
BaseURL: os.Getenv("PARABLE_API_URL"),
Auth: &webapisdk.AuthConfig{Token: os.Getenv("PARABLE_API_TOKEN")},
RequestInterceptor: func(ctx context.Context, req *http.Request) error {
req.Header.Set("X-Tenant", os.Getenv("PARABLE_WORKSPACE"))
return nil
},
})
if err != nil {
return err
}
query := &namespaces.ParableAuthoringGetParablePlotDataManifestQueryParams{}
result, err := sdk.ParableAuthoringNamespace.GetParablePlotDataManifest(ctx, "example", query){
"data": {
"contractVersion": "<string>",
"parable": {
"entityKey": "<string>",
"slug": "<string>"
},
"plots": [
{
"columns": [
{
"name": "<string>",
"primitive": "<string>",
"sortable": true,
"scalarRef": "<string>"
}
],
"entityKey": "<string>",
"handle": "<string>",
"requiresReportingRun": true,
"schemaStatus": "AVAILABLE",
"slug": "<string>",
"outputSchemaUpdatedAt": "2023-11-07T05:31:56Z",
"unavailableReason": "<string>"
}
],
"ref": "<string>"
},
"meta": {
"requestId": "<string>",
"totalCount": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
}
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}Access
An MCP token or a Parable token can call this operation. See Authentication for the kinds of token. Your roles must grant one oftenant.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
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
Workspace slug. Overrides subdomain-based workspace resolution when provided.
Example:
"acme"
Optional request correlation ID echoed back in the response.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Path Parameters
rootRefId parameter UUID v4 with automatic base62 encoding for client-facing APIs
Query Parameters
UUID v4 with automatic base62 encoding for client-facing APIs
UUID v4 with automatic base62 encoding for client-facing APIs