Python SDK
import json
import os
from parable_types_web_api import ReportRunBudgetInput
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"]},
)
)
input_data = ReportRunBudgetInput.model_validate(
json.loads("{}"),
)
result = sdk.parable_authoring.raise_workspace_parable_report_plot_budget('example', 'example', 'example', input_data)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
}
var input webapitypes.ReportRunBudgetInput
if err := json.Unmarshal([]byte(`{}`), &input); err != nil {
return err
}
result, err := sdk.ParableAuthoringNamespace.RaiseWorkspaceParableReportPlotBudget(ctx, "example", "example", "example", input){
"data": {
"forced": true,
"id": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"plotResults": [
{
"id": "<string>",
"plotEntityKey": "<string>",
"plotEntityVersion": 0,
"plotName": "<string>",
"rowCountHidden": true,
"spentCalls": 123,
"spentCost": 123,
"status": "pending",
"updatedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"errorMessage": "<string>",
"maxCost": {
"value": 4503599627370495
},
"maxExternalCalls": {
"value": 4503599627370495
},
"reusedFrom": {
"occurredAt": "2023-11-07T05:31:56Z",
"preview": true,
"reportRunId": "<string>"
},
"rowCount": 0,
"startedAt": "2023-11-07T05:31:56Z"
}
],
"preview": true,
"publishedCommitId": "<string>",
"reportKey": "<string>",
"sources": [
{
"delivery": "batch",
"id": "<string>",
"name": "<string>",
"connectionStatus": "disabled",
"connectionStatusMessage": "<string>",
"dataAsOf": "2023-11-07T05:31:56Z",
"hasData": true,
"logoUrl": "<string>",
"provider": "<string>",
"streamsOff": [
"<string>"
],
"tenantConnectorId": "<string>",
"vendorName": "<string>"
}
],
"status": "pending",
"trigger": "scheduled",
"triggerSources": [
{
"completedAt": "2023-11-07T05:31:56Z",
"kind": "provider_tap",
"name": "<string>",
"sourceId": "<string>"
}
],
"completedAt": "2023-11-07T05:31:56Z",
"durationMs": 0,
"failureMessage": "<string>",
"planKey": "<string>",
"proposalId": "<string>",
"requestedBy": {
"id": "<string>",
"kind": "organization",
"name": "<string>"
},
"typicalDurationMs": 0,
"unavailableReason": "<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>"
}Raise a Report Plot budget
Raises the cost, call or runtime caps of one Plot that paused at its budget in a Report run, and resumes it. The caps apply to this run only; the published Plot does not change.
POST
/
api
/
parables
/
authoring
/
primaries
/
{rootRefId}
/
report-runs
/
{reportRunId}
/
plots
/
{plotKey}
/
actions
/
raise-budget
Python SDK
import json
import os
from parable_types_web_api import ReportRunBudgetInput
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"]},
)
)
input_data = ReportRunBudgetInput.model_validate(
json.loads("{}"),
)
result = sdk.parable_authoring.raise_workspace_parable_report_plot_budget('example', 'example', 'example', input_data)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
}
var input webapitypes.ReportRunBudgetInput
if err := json.Unmarshal([]byte(`{}`), &input); err != nil {
return err
}
result, err := sdk.ParableAuthoringNamespace.RaiseWorkspaceParableReportPlotBudget(ctx, "example", "example", "example", input){
"data": {
"forced": true,
"id": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"plotResults": [
{
"id": "<string>",
"plotEntityKey": "<string>",
"plotEntityVersion": 0,
"plotName": "<string>",
"rowCountHidden": true,
"spentCalls": 123,
"spentCost": 123,
"status": "pending",
"updatedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"errorMessage": "<string>",
"maxCost": {
"value": 4503599627370495
},
"maxExternalCalls": {
"value": 4503599627370495
},
"reusedFrom": {
"occurredAt": "2023-11-07T05:31:56Z",
"preview": true,
"reportRunId": "<string>"
},
"rowCount": 0,
"startedAt": "2023-11-07T05:31:56Z"
}
],
"preview": true,
"publishedCommitId": "<string>",
"reportKey": "<string>",
"sources": [
{
"delivery": "batch",
"id": "<string>",
"name": "<string>",
"connectionStatus": "disabled",
"connectionStatusMessage": "<string>",
"dataAsOf": "2023-11-07T05:31:56Z",
"hasData": true,
"logoUrl": "<string>",
"provider": "<string>",
"streamsOff": [
"<string>"
],
"tenantConnectorId": "<string>",
"vendorName": "<string>"
}
],
"status": "pending",
"trigger": "scheduled",
"triggerSources": [
{
"completedAt": "2023-11-07T05:31:56Z",
"kind": "provider_tap",
"name": "<string>",
"sourceId": "<string>"
}
],
"completedAt": "2023-11-07T05:31:56Z",
"durationMs": 0,
"failureMessage": "<string>",
"planKey": "<string>",
"proposalId": "<string>",
"requestedBy": {
"id": "<string>",
"kind": "organization",
"name": "<string>"
},
"typicalDurationMs": 0,
"unavailableReason": "<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
This operation needs a Parable token. An MCP token cannot call it. See Authentication for the kinds of token. Your roles must granttenant.parables.runs.budget.override.
Errors
PA-AU-001: The Parable, the Report run or the Plot was not found in this Workspace. Check the rootRefId, reportRunId and plotKey.PA-AU-019: The caller cannot raise a budget on this Parable. Use a Workspace identity with the budget override permission and the Primary seat.PA-AU-005: No cap was given or a cap is not above the current cap and what the Plot has used (400), or the Plot is not paused at its budget (409). Give at least one cap above both the current cap and the use so far, on a Plot that shows Budget paused.
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
reportRunId parameter UUID v4 with automatic base62 encoding for client-facing APIs
plotKey parameter UUID v4 with automatic base62 encoding for client-facing APIs
Body
application/json
New caps for a query run that Parable paused at its budget
(BUDGET_EXCEEDED).
At least one cap is required, and Parable decides: each cap must exceed
the run's current cap and what it has already used -- spend for maxCost,
calls for maxExternalCalls, and the time since the run started for
maxRuntime. The caps are the run's; the Plot's published caps never change.
Smallest currency unit, as every Plot cost cap.
Required range:
0 <= x <= 9007199254740991Required range:
x >= 0Signed integer count of milliseconds: an amount of elapsed time, never a point in time. An epoch timestamp is Temporal.DateTime with x-temporal-format: unix_millis.
Required range:
0 <= x <= 9007199254740991