Hanzo AI
OpenapiTeam

Create rooms

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

POST /v1/team/rooms

Addresshttps://api.hanzo.ai/v1/team/rooms
MethodPOST
Operationpost_team_rooms
AuthAuthorization: Bearer $HANZO_API_KEY

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

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

TWO TRANSACTIONS, NOT ONE, when the request states a facet. The document and its mixin are separate writes in this model (bindRoom 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 room with default intent, which is the honest partial state.

Request

7 fields, body application/json (required).

FieldInTypeRequiredDescription
bindingsbodystring[]Bindings are what the room is about, each "<kind>:<ref>".
lifebodystringLife is the lifecycle intent, "standing" or "bound"; empty reads standing.
membersbodystring[]Members are the account uuids in the room.
namebodystringName is what a person sees in a sidebar — "bugfix-1010", not "#bugfix-1010".
privatebodybooleanPrivate restricts the room to its members.
spacebodystringSpace is where the room is opened. Optional: an org with one space has no choice to make, so it does not have to state one.
topicbodystringTopic is the room's one-line subject.

Response

StatusBodyMeaning
201team.teamRoomcreated
defaultproblem-detailsrefused

201 body — 10 fields.

FieldInTypeAlwaysDescription
archivedbodybooleanArchived reports that the room has been closed.
bindingsbodystring[]Bindings are what this room is ABOUT, each a "<kind>:<ref>" string — "project:acme/web", "repo:hanzoai/cloud", "issue:1010".
directbodybooleanDirect reports that this is a room between people rather than a named room.
idbodystringID is the room document's own id, and the value the bind op addresses.
lifebodystringLife is the room's lifecycle INTENT — "standing" or "bound" (HIP-0523 §2).
membersbodystring[]Members are the account uuids in the room, agents included: an agent projects as a space member under a uuid derived from its id, so a caller comparing this…
namebodystringName is what a person sees in a sidebar.
privatebodybooleanPrivate reports that the room is restricted to its members.
spacebodystringSpace is the space uuid holding this room.
topicbodystringTopic is the room's own one-line subject, as the Team client sets it.

Failure carries the platform error shape — see Errors.

Examples

hanzo team rooms create

Team API · All Hanzo APIs · Interactive reference

How is this guide?

On this page