Create channels

Opens a named channel and answers it as the store now holds it.

POST /v1/team/channels

Team → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/team/channels`
Method	`POST`
Operation	`post_team_channels`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Opens a named channel and answers it as the store now holds it.

It writes through the SAME applyTx path the Team client uses, so a channel opened here is broadcast to every live client of the space and appears in an open sidebar without a reload — the same property listChannels rests on, read from the write side.

A SIGNED-IN TEAM MEMBER opens it as themselves: they are its first member and its owner, every other member named must be somebody the space knows (a person in it, or one of the org's agents), and a guest may not open channels at all. An application of the org opens it as the org, with exactly the members it names. Anybody else without a team session is 401.

TWO TRANSACTIONS, NOT ONE, when the request states a facet. The document and its mixin are separate writes in this model (bindChannel writes only the second), and composing them here rather than inventing a combined tx keeps one write path for each. A create that lands and a facet that does not is visible as a channel with default intent, which is the honest partial state.

Request

7 fields, body application/json (required).

Field	In	Type	Required	Description
`bindings`	body	string[]	—	Bindings are what the channel is about, each "<kind>:<ref>".
`life`	body	string	—	Life is the lifecycle intent, "standing" or "bound"; empty reads standing.
`members`	body	string[]	—	Members are the account uuids in the channel.
`name`	body	string	—	Name is what a person sees in a sidebar — "bugfix-1010", not "#bugfix-1010".
`private`	body	boolean	—	Private restricts the channel to its members.
`space`	body	string	—	Space is where the channel is opened.
`topic`	body	string	—	Topic is the channel's one-line subject.

Response

Status	Body	Meaning
`201`	team.teamChannelOne	created
`default`	problem-details	refused

201 body — 12 fields.

Field	In	Type	Always	Description
`channel`	body	team.teamChannel	—
`channel.archived`	body	boolean	—	Archived reports that the channel has been closed.
`channel.bindings`	body	string[]	—	Bindings are what this channel is ABOUT, each a "<kind>:<ref>" string — "project:acme/web", "repo:hanzoai/cloud", "issue:1010".
`channel.direct`	body	boolean	—	Direct reports that this is a channel between people rather than a named channel.
`channel.id`	body	string	—	ID is the channel document's own id, and the value the bind op addresses.
`channel.kind`	body	string	—	Kind is what sort of channel this is: "public" (open to everyone in the space), "private" (open to its members) or "dm" (a conversation between the people in it).
`channel.life`	body	string	—	Life is the channel's lifecycle INTENT — "standing" or "bound" (HIP-0523 §2).
`channel.members`	body	string[]	—	Members are the account uuids in the channel, agents included: an agent projects as a space member under a uuid derived from its id, so a caller comparing this against GET /v1/bot/members learns which channels an agent is in.
`channel.name`	body	string	—	Name is what a person sees in a sidebar.
`channel.private`	body	boolean	—	Private reports that the channel is restricted to its members.
`channel.space`	body	string	—	Space is the space uuid holding this channel.
`channel.topic`	body	string	—	Topic is the channel's own one-line subject, as the Team client sets it.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo team channels create

.ts

.py

.go

.rs

.java

import { Configuration, TeamApi } from 'hanzoai';

const api = new TeamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postTeamChannels({ bindings: ["<bindings>"], life: "<life>" });

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TeamApi(client).post_team_channels(bindings=["<bindings>"], life="<life>")

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

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

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

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

let result = team_api::post_team_channels(&cfg, Default::default()).await?;

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

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

var result = new TeamApi(client).postTeamChannels();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were 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 POST https://api.hanzo.ai/v1/team/channels \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "bindings": [
         "<bindings>"
       ],
       "life": "<life>"
     }'

MCP reaches team through the team tool, which names its 33 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_team_account_providers"
         }
       }
     }'

Team API · All Hanzo APIs · Interactive reference

Was this page useful?

Broken link or missing step? Drop it in #docs on Discord or open a PR.

PreviousCreate messages NextCreate rpc