Appearance
data.agents.budget-status ​
Report budget utilisation for an organisation for a given period
Report budget utilisation for an organisation.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-agents |
| Version | 1.0 |
Triggers ​
| Source | Endpoint / Event | Description |
|---|---|---|
| API | GET /api/agents/{resource} | Read-only data query for the agents platform |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | string | Yes | — | — |
period | string | No | monthly | Reporting window. Accepted values: daily |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
budget_usd | json | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
failed_at_state | string | No | — | — |
failed_layer | json | No | — | — |
failed_step | string | No | — | — |
failure_reason | string | No | — | — |
over_budget | json | No | — | — |
pct_used | json | No | — | — |
period | json | No | — | — |
spent_usd | json | No | — | — |
organization_uuid | json | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | run | — |
run | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | run | run | — |
run | complete | completed | — |
* (any state) | fail | failed | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
fetched | SUCCESS | Budget status fetched | budget_usd, spent_usd, over_budget, organization_uuid |
failed | FAILURE | Budget status fetched failed | failure_reason, error, error_type, failed_at_state, failed_step, failed_layer |
Business Errors ​
| Code | Message Template |
|---|---|
AGENTS_ORGANIZATION_CONTEXT_INVALID | Authenticated organization context is missing or does not match the workflow input |
AGENTS_CONFIG_NOT_FOUND | Agent configuration {agent_config_uuid} was not found in the organization |
AGENTS_SKILL_NOT_FOUND | Agent skill {skill_uuid} was not found in the organization |
AGENTS_SESSION_NOT_FOUND | Agent session {session_uuid} was not found in the organization |
AGENTS_MCP_SERVER_NOT_FOUND | MCP server {mcp_server_uuid} was not found in the organization |
AGENTS_DATASET_NOT_FOUND | Fine-tuning dataset {dataset_uuid} was not found in the organization |
AGENTS_PACKAGE_NOT_FOUND | Skill/guidance package {package_uuid} was not found in the organization |
AGENTS_RUNNER_GROUP_NOT_FOUND | Runner group {runner_group_uuid} was not found in the organization |
AGENTS_VALIDATION_FAILED | Workflow input or domain state failed validation: |
AGENTS_CONFLICT | Conflicting agent domain state: |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "data.agents.budget-status",
"initial_data": {
"organization_uuid": "value"
}
}