Skip to content

HTTP: causal-budgets

Default control-plane operations. Complete OpenAPI schema · Authentication and tenancy.

GET /api/causal-budgets/{causal_budget_id}/usage

Section titled “GET /api/causal-budgets/{causal_budget_id}/usage”

Get Causal Budget Usage

Operation ID: get_causal_budget_usage_api_causal_budgets__causal_budget_id__usage_get.

Parameter Location Required Schema
causal_budget_id path True {"type":"string","minLength":1,"title":"Causal Budget Id"}
{
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CausalBudgetUsageSummary"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}

Model declarations: CausalBudgetUsageSummary, HTTPValidationError.

POST /api/causal-budgets/{causal_budget_id}/cost

Section titled “POST /api/causal-budgets/{causal_budget_id}/cost”

Estimate Causal Budget Cost

Operation ID: estimate_causal_budget_cost_api_causal_budgets__causal_budget_id__cost_post.

Parameter Location Required Schema
causal_budget_id path True {"type":"string","minLength":1,"title":"Causal Budget Id"}
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionCostBody"
}
}
}
}

Model declarations: SessionCostBody.

{
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CausalBudgetCostSummary"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}

Model declarations: CausalBudgetCostSummary, HTTPValidationError.

POST /api/causal-budgets/{causal_budget_id}/summary

Section titled “POST /api/causal-budgets/{causal_budget_id}/summary”

Get Causal Budget Summary

Operation ID: get_causal_budget_summary_api_causal_budgets__causal_budget_id__summary_post.

Parameter Location Required Schema
causal_budget_id path True {"type":"string","minLength":1,"title":"Causal Budget Id"}
{
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SessionCostBody"
}
}
}
}

Model declarations: SessionCostBody.

{
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CausalBudgetSummaryResponse"
}
}
}
},
"413": {
"description": "The causal-budget summary exceeds its session or serialized response safety bound.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"501": {
"description": "The configured session store cannot enforce bounded accounting reads.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiErrorResponse"
}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}

Model declarations: ApiErrorResponse, CausalBudgetSummaryResponse, HTTPValidationError.