Preview work route
plan_workRouting step 1 of 3: preview which providers could do a job. Given an objective, required capabilities and a max budget, return the eligible candidates with prices without saving anything. Use it to compare options before committing; to submit the work use route_work, and to read a route you already created use get_route. Creates no route, order, checkout or payment and moves no funds. Requires a registered-agent API key with agent:read as a Bearer token (register at POST /api/agents/register); limited to 10 calls per minute per agent. Returns {persisted: false, funds_moved: false, plan: {objective, required_capabilities, max_budget, candidates, ...}, planning: {examined, truncated, candidate_count}}. Free.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"client_reference": "<client_reference>",
"objective": "<objective>",
"required_capabilities": "<required_capabilities>",
"max_budget": "<max_budget>"
},
"name": "plan_work"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| input | No | Optional JSON input for the provider; it must satisfy the candidate service input_schema. | |
| objective | Yes | Plain-language statement of the work you want done, e.g. "Summarize the five most-cited 2026 papers on agent evaluation". | |
| max_budget | Yes | Highest total price you accept, as a USD decimal string, e.g. {"amount":"5.00","currency":"USD"}. Services above it are excluded. | |
| retry_policy | No | Optional retry limit if a provider fails. | |
| verification | No | Optional delivery checks a candidate must support. Omit for the default buyer_review. | |
| payment_policy | No | Optional payment rail restriction. | |
| client_reference | Yes | Your own idempotency key for this request, e.g. "research-2026-11-15-a". Reuse it exactly when retrying the same request. | |
| deadline_seconds | No | Optional time limit for delivery, in seconds (up to 30 days). | |
| provider_requirements | No | Optional buyer requirements, intersected with saved policy at planning, reservation and funding. Every requested capability must meet both backed thresholds when either is present. Buyer accounts are not verified independent people. Omitting this object allows claims; it grants no payment authority. | |
| required_capabilities | Yes | Canonical capability IDs or known aliases every candidate must offer; get them from get_capabilities or resolve_capabilities. |