



























The Agent SDK now supports a fourth tool type: human-in-the-loop (HITL) tools. They let your agent handle routine calls automatically and pause for a human when stakes are high, all controlled by a single hook.
Install the SDK, define your HITL tool, and follow the cookbook recipe for a working implementation.
npm install @openrouter/agent
Regular tools always execute. Manual tools always pause. HITL tools do both: your onToolCalled hook inspects the input and decides.
import { tool } from '@openrouter/agent/tool';
import { z } from 'zod';
const approvePayment = tool({
name: 'approve_payment',
description: 'Approve a payment, escalating large amounts to a human',
inputSchema: z.object({
amount: z.number(),
recipient: z.string(),
}),
outputSchema: z.object({
approved: z.boolean(),
reviewedAt: z.number().optional(),
}),
onToolCalled: async (input) => {
if (input.amount < 100) {
return { approved: true };
}
// Pause for human review
return null;
},
});
Return a value and the agent keeps going (like a regular tool). Return null and the loop pauses with status: 'awaiting_hitl', surfacing the pending call to your application. You resume by calling callModel again with a function_call_output item containing the human’s decision.
This pattern fits anywhere the decision depends on data: dollar thresholds, risk scores, content policy flags, compliance checks. The branching logic lives in one function, not scattered across your application code.
An optional second hook, onResponseReceived, fires when a human supplies a result for a paused call. It transforms the raw input before passing it to the model.
onResponseReceived: async (raw) => {
return { ...(raw as Record<string, unknown>), reviewedAt: Date.now() };
},
Use it to stamp metadata, normalize formats, validate against business rules, or enrich the response with context the human didn’t need to provide manually. If it throws, the error surfaces to the model as { error: ..., originalOutput: ... } so nothing gets silently swallowed.
Here’s the full lifecycle:
onToolCalled runs. If it returns a value, the agent continues. If it returns null, the loop pauses.getToolCalls() and presents them to the user.callModel again with the decision as a function_call_output item.onResponseReceived (if defined) transforms the response.const result = openrouter.callModel({
model: 'openai/gpt-4o',
input: 'Pay $500 to Acme Corp for the May invoice',
tools: [approvePayment] as const,
state,
});
const response = await result.getResponse();
if (response.state?.status === 'awaiting_hitl') {
const pending = response.state.pendingToolCalls ?? [];
// Present pending[0] to your user, collect their decision, then resume:
const resumed = openrouter.callModel({
model: 'openai/gpt-4o',
input: [{
type: 'function_call_output' as const,
callId: pending[0].id,
output: JSON.stringify({ approved: true }),
}],
tools: [approvePayment] as const,
state,
});
}
The SDK handles all the state tracking, hook dispatch, and schema validation. You wrote zero loop code.
Both pause for human input. The difference is in the decision logic.
HITL (onToolCalled) | requireApproval | |
|---|---|---|
| When it pauses | Only when your hook returns null | Always, before any execution |
| Decision type | Data-driven (thresholds, scoring, policy) | Binary yes/no consent |
| Auto-resolve | Return a value to skip human review | Not available |
| Post-processing | onResponseReceived transforms the response | Not available |
Use requireApproval when every invocation needs explicit human consent regardless of input (think: “delete this database,” “send this email”). Use HITL when some calls can proceed automatically and others need a human (think: “approve this payment if it’s under $100”).
The HITL tools cookbook recipe walks through a complete implementation: defining the tool, detecting pauses, collecting human input, and resuming the loop.
For the full type signatures and API surface, see the tools documentation and the API reference.
Get your API key and tell us what you’re building on Discord.
此内容由惯性聚合(RSS阅读器)自动聚合整理,仅供阅读参考。 原文来自 — 版权归原作者所有。