Stop Conditions

Not yet available. The Agent SDK is tracked to be built — today, use the Client SDKs against the live chat completions API. The docs below describe the intended design.

Stop conditions are declarative rules that tell callModel() when to stop calling the model. Instead of checking return values inside your loop body, you declare the exit conditions once and let the SDK enforce them.

Built-in stop conditions#

no_tool_calls#

Stop when the model completes a turn without making any tool calls. The most common condition for task-completion: the agent is done when it stops reaching for tools.

stopConditions: [{ type: "no_tool_calls" }]

max_turns#

Hard cap on the number of turns. Prevents runaway loops.

stopConditions: [{ type: "max_turns", maxTurns: 10 }]

balance_below#

Stop before the agent runs out of DA balance. The threshold is in micro-DA (1 DA = 1,000,000 micro-DA).

// Stop when balance drops below 50 DA (50,000,000 micro-DA)
stopConditions: [{ type: "balance_below", threshold: 50_000_000n }]

Note. This condition is checked after each turn using the X-Balance-Available response header. The final turn that crosses the threshold will still complete.

output_schema#

Stop when the model's output matches a JSON Schema. Useful for structured-output agents that should loop until they produce a valid answer.

stopConditions: [
  {
    type: "output_schema",
    schema: {
      type: "object",
      properties: {
        answer: { type: "string" },
        confidence: { type: "number" },
      },
      required: ["answer", "confidence"],
    },
  },
]

custom#

Full escape hatch. Provide a function that receives the TurnResult and returns true to stop.

stopConditions: [
  {
    type: "custom",
    check: (result) => result.output.includes("FINAL_ANSWER:"),
  },
]

Combining conditions#

List multiple conditions to stop on whichever is met first:

stopConditions: [
  { type: "no_tool_calls" },
  { type: "max_turns", maxTurns: 15 },
  { type: "balance_below", threshold: 10_000_000n },
]

Checking why the loop stopped#

result.stopReason tells you which condition ended the turn:

const result = await client.callModel({ ... });

if (result.stopReason === "stop_condition_met") {
  // Check which condition fired via result.stoppedBy
  console.log("Stopped by:", result.stoppedBy);
}

Dynamic stop conditions#

Stop conditions can also be returned from dynamicParams — useful when the threshold depends on runtime state. See Dynamic Parameters.

Also see#

• Call Model — the callModel() API.
• Dynamic Parameters — runtime-computed conditions.
• Next Turn Params — passing counters across turns.
• API Reference — full type definitions.