runs.start when a job, workflow, tool, agent, or custom workload needs a budget envelope
before it starts. The customer remains the economic actor; the run is the workload label and spend
reservation.
Request
string
The customer ID. Required when the API key has no default customer binding.
number
required
Budget in currency minor units. For USD,
5000 means $50.00.string
required
Logical key used to deduplicate the run start request.
"agent" | "workflow" | "job" | "tool" | "custom"
Optional label for the kind of workload that will spend the budget.
string
Optional ID from your system for the workload.
string
Optional trace ID for connecting the run to your logs or traces.
string
Optional parent run ID for nested workloads.
object
Optional metadata stored with the run.
number
Optional epoch-millisecond expiration timestamp.
Response
Returns the started budget run.remainingAmountMinor is the amount still available for
runs.consume.