Hanzo AIDocs
Sign inAPI key

Create dms

Opens the direct message between the caller and the people named, or answers the one that already exists — there is one conversation per set of people, however many times it is asked for.

POST /v1/team/dms

Team → · All API references → · Get started →

Addresshttps://api.hanzo.ai/v1/team/dms
MethodPOST
Operationpost_team_dms
AuthAuthorization: Bearer $HANZO_API_KEY

Opens the direct message between the caller and the people named, or answers the one that already exists — there is one conversation per set of people, however many times it is asked for.

Every person named must be a member of the space or one of the org's agents; a direct message with an agent is a conversation it answers every message in, and a guest may not open one. Answers 201 when this call opened it and 200 when it was already there.

Request

2 fields, body application/json (required).

FieldInTypeRequiredDescription
membersbodystring[]—Members are the account uuids to talk to — people or agents of the space.
spacebodystring—Space is the space uuid.

Response

StatusBodyMeaning
200team.teamDirectok
201team.teamDirectcreated
defaultproblem-detailsrefused

200 body — 13 fields.

FieldInTypeAlwaysDescription
createdbodyboolean—Created is true when this call opened the conversation (201) and false when it already existed (200).
roombodyteam.teamRoom—
room.archivedbodyboolean—Archived reports that the room has been closed.
room.bindingsbodystring[]—Bindings are what this room is ABOUT, each a "<kind>:<ref>" string — "project:acme/web", "repo:hanzoai/cloud", "issue:1010".
room.directbodyboolean—Direct reports that this is a room between people rather than a named room.
room.idbodystring—ID is the room document's own id, and the value the bind op addresses.
room.kindbodystring—Kind is what sort of room this is: "channel" (open to everyone in the space), "private" (open to its members) or "dm" (a conversation between the people in it).
room.lifebodystring—Life is the room's lifecycle INTENT — "standing" or "bound" (HIP-0523 §2).
room.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 against GET /v1/bot/members learns which rooms an agent is in.
room.namebodystring—Name is what a person sees in a sidebar.
room.privatebodyboolean—Private reports that the room is restricted to its members.
room.spacebodystring—Space is the space uuid holding this room.
room.topicbodystring—Topic is the room's own one-line subject, as the Team client sets it.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.

import { Configuration, TeamApi } from 'hanzoai';

const api = new TeamApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postTeamDms({ members: ["<members>"], space: "<space>" });
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_dms(members=["<members>"], space="<space>")
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.TeamAPI.PostTeamDms(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_dms(&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).postTeamDms();
curl -X POST https://api.hanzo.ai/v1/team/dms \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "members": [
         "<members>"
       ],
       "space": "<space>"
     }'

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?
PreviousCreate rpcNextCreate comments