Hanzo
API Reference

Hanzo Agents API

Per-org autonomous agent definitions, runs, and the live session control plane (hanzoai/cloud clients/agents).

Per-org autonomous agent definitions, runs, and the live session control plane (hanzoai/cloud clients/agents).

Base URLhttps://api.hanzo.ai
Version1.0.0
Operations20
GuideHanzo Agents API guide

Authentication

  • BearerAuth — HTTP bearer

All Hanzo APIs share one bearer credential and common error and pagination conventions. See API conventions.

curl -H "Authorization: Bearer $HANZO_API_KEY" https://api.hanzo.ai

Endpoints

Agents

MethodEndpointDescription
GET/v1/agentsList agents for the org.
POST/v1/agentsCreate an agent.
GET/v1/agents/{ref}Agent detail plus recent runs.
PATCH/v1/agents/{ref}Update an agent.
DELETE/v1/agents/{ref}Delete an agent and its runs.
POST/v1/agents/{ref}/runRun the agent.
GET/v1/agents/{ref}/runsRun history for the agent.

Overview

MethodEndpointDescription
GET/v1/agents/metricsInvocations-over-time histogram for the org's Agents dashboard.
GET/v1/agents/activityOrg-wide recent-activity feed.

Sessions

MethodEndpointDescription
GET/v1/agents/sessionsList live sessions.
POST/v1/agents/sessionsRegister a live session.
GET/v1/agents/sessions/streamSSE feed of live session and event updates (rides ZAP).
GET/v1/agents/sessions/{id}Session detail plus direct children and recent events.
PATCH/v1/agents/sessions/{id}Update session status or title.
GET/v1/agents/sessions/{id}/treeThe full subagent-flow graph rooted at this session.
POST/v1/agents/sessions/{id}/eventsAppend an event to a session's ordered log.
POST/v1/agents/sessions/{id}/pausePause a session (control command).
POST/v1/agents/sessions/{id}/resumeResume a session (control command).
POST/v1/agents/sessions/{id}/stopStop a session (control command).
POST/v1/agents/sessions/{id}/messageSend a message to a session (control command).

Hanzo Agents API guide · All Hanzo APIs · OpenAPI spec

How is this guide?

On this page