Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.xhipai.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Human-in-the-Loop Approval Gates

Agentium supports requiring human approval before executing sensitive tool calls. Approvals work via callbacks, events, or REST API.

​
Configuration

import { Agent, openai } from "@agentium/core";

const agent = new Agent({
  name: "careful-bot",
  model: openai("gpt-4o"),
  tools: [deleteTool, readTool],
  approval: {
    policy: ["delete_record"], // only this tool needs approval
    timeout: 60_000,
    timeoutAction: "deny", // "approve" | "deny" | "throw"
  },
});

​
REST API

When using the transport layer, three approval endpoints are automatically available:
EndpointMethodDescription
/approvals/pendingGETList all pending approval requests
/approvals/:requestId/approvePOSTApprove a pending request
/approvals/:requestId/denyPOSTDeny a pending request
/approvals/streamGET (SSE)Real-time stream of new approval requests

​
SSE Integration

const source = new EventSource("/approvals/stream");
source.onmessage = (event) => {
  const request = JSON.parse(event.data);
  // Show approval UI to human reviewer
  showApprovalDialog(request);
};

​
Timeout Actions

ActionBehavior
"deny" (default)Auto-deny when timeout expires
"approve"Auto-approve when timeout expires
"throw"Throw an error when timeout expires