camelAI Documentation

Guides

Multi-agent

Sub-agents: the delegate built-in hands tasks to other agents, in parallel; limits, cancelling, crash safety, progress events, and the OpenAI Agents SDK and LangGraph mapped

View as Markdown · Docs index for coding agents

The delegate built-in lets an agent hand a task to a sub-agent and get its answer back as the call's result, while it keeps the conversation. This is the OpenAI Agents SDK's agent.as_tool() and LangGraph's supervisor. The runtime runs it, and it is durable: a sub-agent is an agent of its own, and a parent whose node is lost while it waits collects the sub-agent's answer on another node.

camelRun has no handoffs: an agent cannot pass its conversation to another agent. See Coming from the OpenAI Agents SDK.

Sub-agents: delegate

Give an agent the delegate builtin and say whom it may delegate to: its agents, by definition key or id. The SDKs add the builtin when you pass the settings.

await agents.runtime.upsertDefinition("researcher", {
  name: "Researcher", description: "Finds sources and summarizes them",
  systemPrompt: "You research a question and answer with sources.", builtins: ["web_search", "web_fetch"],
});

const lead = await agents.upsert("research-lead", {
  instructions: "You plan research and write the report. Delegate each question to the researcher.",
  delegate: { agents: ["researcher"] },
});
const run = await lead.run("Compare the three largest EV makers' 2025 margins.");

A definition takes the same settings, for every agent made from it:

json
{ "name": "Research lead", "systemPrompt": "…", "builtins": ["delegate"], "delegate": { "agents": ["researcher", "writer"] } }

The model gets a delegate tool that lists the agents with what each is for (the definition's description, unless the entry gives its own):

Argument
agentWhich agent, by its name in the list
instructionsInstead of agent, with instructions: true in the settings: a system prompt for a sub-agent the model designs itself, on its own model
taskWhat to do. The sub-agent sees only this, not the conversation
outputA JSON Schema for an object: the answer comes back in that shape (see Structured output)

The call's result is { agentId, requestId, status, text, output?, error? }. status is completed, input_required (the sub-agent waits on a person) or failed. The model sees a failed or waiting sub-agent as a failed call, with the reason.

Who the sub-agent is

An entry in agents is one of these:

EntryThe sub-agent
"researcher" or { definition: "researcher", name?, description? }A new agent made from the definition, for each call
{ agent: "billing-specialist", name?, description? }Your existing agent with that key. It keeps its own history across calls. Runs queue, one at a time, like any of its runs
instructions: true (a setting, not an entry)A new agent with the model's instructions, the parent's model, and the parent's web_search and web_fetch if it has them

A sub-agent the runtime makes is a real agent:

  • It is linked to its parent: parentAgentId and parentRunId in GET /v1/agents/{id} and the agent list, and in the metadata of its run.
  • It acts for whom the parent acts (subject, context) and uses the parent's key scope. It is billed to the same account.
  • It has its own workspace. Pass it what it needs in the task, or mount a shared volume in both definitions.
  • It lives a day, as a scratch agent does. Read its history in the meantime with its id, from run.toolCalls:
ts
const call = run.toolCalls.find(call => call.tool === "delegate");
const child = await agents.get(call.agentId!);
console.log(await child.history());

Parallel sub-agents

The model may call delegate several times in one response. The calls run at once, up to maxParallel (default 4) per run; the rest wait their turn. This is map-reduce: one call per item, and the model combines the answers.

ts
delegate: { agents: ["researcher"], maxParallel: 8 }

Limits

Sub-agents are agents, so everything that bounds agents bounds them, and the parent's limits cover them:

Limit
DepthA sub-agent's sub-agents count. Delegation stops at maxDepth (default 2: a parent, its children and theirs; at most 5). Past it, the call fails and the model does the work itself
Fan-outmaxParallel calls in flight per run (default 4, at most 16)
Busy agentsA running sub-agent takes one of your account's busy slots. At the limit, the call fails with BUSY_AGENT_LIMIT
SpendYour account's spend limits apply to sub-agents too. A parent's own spend limits (the agent's, and the run's spendLimit) bound its sub-agents: each gets what the parent has left as its run's spend limit, and what it spent counts against the parent's. run.usage.subagentCostUsd says how much that was
Run rate and run limitsA sub-agent's run counts against your account's run rate. Its definition's runLimits apply to it

Parallel sub-agents each start with what the parent has left, so together they can pass the parent's limit by at most one sub-agent's spend each.

An agent cannot delegate to an agent already working on its chain (it would wait on itself), and an agent's own key cannot change any of these settings. The model calls delegate directly, never from js_exec.

Cancelling

Aborting the parent's run (agent.abort(), POST /v1/agents/{id}/abort) aborts the sub-agents it is waiting on. So does deleting the parent. A named agent is aborted only while it runs the parent's task, never another.

When a node is lost

A sub-agent is keyed by the parent's tool call, and its run by the call too. If the parent's node is lost while it waits, the parent's run resumes on another node and makes the call again. That call finds the same sub-agent and run, and waits for its answer; the task never runs twice. The sub-agent, if its own node was lost, resumes like any agent.

Watching sub-agents

A sub-agent's progress can appear on its parent's event stream. Ask for it: subagents: true in the SDKs, or ?subagents=1 on the events URL. Without it you get none of these events.

Event
subagent_start{ toolCallId, agentId, requestId, name, depth }: the call started its sub-agent
subagent_event{ toolCallId, agentId, event }: one of the sub-agent's events (its streamed text left out). A grandchild's events arrive nested in its parent's
subagent_end{ toolCallId, agentId, requestId, status, error? }
ts
const lead = await agents.upsert("research-lead", { delegate: { agents: ["researcher"] }, subagents: true });
for await (const part of lead.stream("…")) {
  if (part.type === "subagent_start") console.log(`→ ${part.name} (${part.agentId})`);
  if (part.type === "subagent_end") console.log(`← ${part.agentId}: ${part.status}`);
}

In a browser, the watcher (@camelai/run/watch, with subagents: true) folds them into state.subagents, by delegate call, and a chat made with watch: { subagents: true } shows each sub-agent as a collapsible transcript under its call in <AgentChat> (part.subagent for a tool renderer of your own). A browser token that lists its events needs these types listed too.

A sub-agent's events are relayed while it runs on the same node as its parent, which it does unless a node was lost; its own stream and history always have everything.

Coming from the OpenAI Agents SDK

OpenAI Agents SDKcamelRun
agent.as_tool(tool_name, tool_description)delegate: { agents: [{ name, definition, description }] }
Agents as tools in parallel (asyncio.gather in a tool)Several delegate calls in one response run at once (maxParallel)
handoffs=[…], handoff()Not supported: there are no handoffs. Delegate to the specialist instead: the conversation stays with the first agent, which relays the answer. Or route in your code, running the agent the message is for (see Migrating)
max_turnsThe run's runLimits, and delegate.maxDepth for chains of agents

Coming from LangGraph

LangGraphcamelRun
Supervisor (create_supervisor, or a supervisor node routing to workers)A lead agent with delegate: { agents: [...] }: the model routes, workers answer as tool results
Subgraphs (a compiled graph as a node)A definition per subgraph, delegated to. Its history is its own agent's
Send (map-reduce over items)Parallel delegate calls, one per item
Swarm (create_swarm), Command(goto=…)Not supported: there are no handoffs. Use a supervisor (delegate) instead
Shared state between nodesThe task text, and a shared volume
recursion_limitdelegate.maxDepth and the run's runLimits
Checkpointed subgraph stateEach sub-agent's own history, read by its id (run.toolCalls[i].agentId)