Replace agent

Binds agents to the caller org's channel and answers the bindings as GET would. It requires ORG ADMIN.

PUT /v1/channel/agent

Channel → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/channel/agent`
Method	`PUT`
Operation	`put_channel_agent`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Binds agents to the caller org's channel and answers the bindings as GET would. It requires ORG ADMIN. The agent is named by its ref — the name an org gave it at POST /v1/agent, or a built-in such as dev, des or vi.

Request

5 fields, body application/json (required).

Field	In	Type	Required	Description
`channel`	body	string	—	Channel is the transport to edit.
`default`	body	string	—	Default sets the agent for rooms with no binding of their own; "hanzo" restores the built-in.
`rooms`	body	object	—	Rooms binds platform room ids to agents; rooms not named are left alone.
`rooms.*`	body	string	—
`unbind`	body	string[]	—	Unbind removes the bindings of these rooms, so they fall back to Default.

Response

Status	Body	Meaning
`200`	channel.channelAgents	ok
`default`	problem-details	refused

200 body — 4 fields.

Field	In	Type	Always	Description
`channel`	body	string	—	Channel is the transport these bindings are for.
`default`	body	string	—	Default is the agent that answers any room without a binding of its own; "hanzo" when the org has never set one.
`rooms`	body	object	—	Rooms maps a platform room id to the agent that answers there.
`rooms.*`	body	string	—

Failure carries the platform error shape — see Errors.

Examples

hanzo channel agent replace

import { Configuration, ChannelApi } from 'hanzoai';

const api = new ChannelApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.putChannelAgent({ channel: "<channel>", default: "<default>" });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ChannelApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ChannelApi(client).put_channel_agent(channel="<channel>", default="<default>")

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.ChannelAPI.PutChannelAgent(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, channel_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = channel_api::put_channel_agent(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ChannelApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new ChannelApi(client).putChannelAgent();

The method above is the one at the current release of the document. [email protected] (npm) was generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl -X PUT https://api.hanzo.ai/v1/channel/agent \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "channel": "<channel>",
       "default": "<default>"
     }'

MCP reaches channel through the channels tool, which names its 7 operations with its own verbs — this one among them, under a name only MCP declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_channels"
         }
       }
     }'

Channel API · All Hanzo APIs · Interactive reference

Request

Response

Examples

On this page