Return budget setup context for an agent-authored budget proposal.

Return budget setup context for an agent-authored budget proposal.

get/v1/budget/context

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/budget/context
  • Auth: HTTP bearer

Query parameters

periodstring

The plan period to read, as YYYY-MM.

limitinteger

Legacy compatibility parameter; does not change period evidence. A capped period read returns observed totals with partial_success status and warnings.

Response

Envelope with category baselines, recurring candidates, active budget, and suggested commands. Monthly averages divide observed posted totals by baseline months with complete source coverage or observed transactions; months with neither are excluded; calculation_basis gives the date range and denominator, while coverage reports completeness. Capped reads retain observed totals with partial status and caveats.

schema_versionstring required
generated_atstring date-time required
request_idstring required
status'success' | 'partial_success' | 'action_required' | 'error' required
user_messagestring

Optional concise user-safe message the calling agent may adapt.

warningsobject[] required
dataobject nullable required

Operation-specific result data, or null when the request ends in an error.

Changes

No recorded changes to this operation across all 1 revision of this API.