Transport

One inbox for the chat apps you connect — Discord, Slack, Teams, Telegram.

Also for this capability: API · CLI · MCP · SDKs

One inbox for the chat apps you connect — Discord, Slack, Teams, Telegram.

Base URLhttps://api.hanzo.ai
Operations9
AuthAuthorization: Bearer $HANZO_API_KEY

Specification

Specification pending — no HIP in hanzoai/hips declares capability: transport yet. What this capability serves is below, from the API document; what it is — the store it owns, how it meters, what it publishes — is written as a HIP under HIP-0139.

Four surfaces

SurfaceReaches this capability asCoverage
RESTtransport at its own prefix9 operations
CLIhanzo transport …9 of 9
SDK—no published client declares one yet — regenerating the clients is what adds them
MCPtool transport on https://api.hanzo.ai/v1/mcp8 operations, 4 under the document's own id — ask describe for the rest

Quickstart

export HANZO_API_KEY=sk-...   # console.hanzo.ai → API keys

Then the first call — a read that needs nothing but the key. GET /v1/transport, operation get_transport:

hanzo transport list
import { Configuration, TransportApi } from 'hanzoai';

const api = new TransportApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getTransport();
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import TransportApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TransportApi(client).get_transport()
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.TransportAPI.GetTransport(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, transport_api};

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

let result = transport_api::get_transport(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.TransportApi;

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

var result = new TransportApi(client).getTransport();

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 https://api.hanzo.ai/v1/transport \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches transport through the transport tool, which names its 8 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_transports"
         }
       }
     }'

Answers 200 with object — ok.

Endpoints

EndpointWhat it does
POST /v1/transport/{transport}/sendSend a message from your org's bot to one chat channel
GET /v1/transport/agentReturns which agent answers the caller org's transport: the default and every channel bound to another agent.
PUT /v1/transport/agentBinds agents to the caller org's transport and answers the bindings as GET would.
GET /v1/transport/allowlistReturns the caller org's access policy for one transport: whether DMs are pairing-gated, allowlisted or open, whether group channels are open, allowlisted or disabled, the config-managed DM and group allow entries, the senders approved through PAIRING (read-only here), and the org's named access groups.
PUT /v1/transport/allowlistEdits the caller org's access policy for one transport and answers the policy as GET would, so both verbs return ONE shape.
GET /v1/transport/inboxReturns the caller's own messages to the org's connected chat bots — those recorded on the caller's linked account — oldest first, in the portable envelope shape every transport normalises into.
POST /v1/transport/pairing/approveTurns one pending pairing code into a standing allow entry, so that person can DM the org's bot on that transport from now on.
GET /v1/transport/pairingReturns the pairing requests waiting for the caller org to approve — one per person who messaged a connected bot on a transport whose DM policy is "pairing" and who is not allowed yet.
GET /v1/transportReports every chat transport this org can send through, and whether it can send through it right now.

All Hanzo APIs · Interactive reference

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