Skip to content
Hexel StudioDocs

Estimate a swarm's cost before creating it

POST/harness/swarms:estimate

Takes the same body as POST /harness/swarms.

Headers

Bearer <token>. A Hexel Studio access token for your organization.

The workspace the request acts in (ws_...). It never grants access by itself.

The environment the request acts in (env_...). It never grants access by itself.

Body parameters

patternstring

One of: "map", "lead_workers", "pipeline", "board"

goalstring
agentstring
worker_agentoptional string
itemsoptional array of any

A map's items.

inputsoptional object
reduceoptional ReduceStep
stagesoptional array of PipelineStageInput

A pipeline's stages.

boardoptional BoardSettings
accessoptional object
budgetoptional object
member_budgetoptional Budget

What a task may spend; it narrows the agent's own budgets. max_estimate_usd is accepted on create only.

max_concurrencyoptional integerint32
failure_ruleoptional FailureRule
sandbox_templateoptional string

Returns

200The estimate (with `parts` by agent).Estimate

admittedboolean
decision_idoptional string
floor_usdoptional numberdouble
max_estimate_usdoptional numberdouble
membersintegerint32
meterstring
partsoptional array of EstimatePart
per_member_usdnumberdouble
quantityintegerint64
reasonsoptional array of string
refusaloptional string
sourcestring
usdnumberdouble

Errors

  • default