Destination

Your events forwarded to the ad and analytics tools you use.

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

Your events forwarded to the ad and analytics tools you use.

Base URL	`https://api.hanzo.ai`
Operations	5
Auth	`Authorization: Bearer $HANZO_API_KEY`

Specification

Specification pending — no HIP in hanzoai/hips declares capability: destination 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

Surface	Reaches this capability as	Coverage
REST	`destination` at its own prefix	5 operations
CLI	`hanzo destination …`	5 of 5
SDK	`DestinationApi` in every published client	5 methods
MCP	tool `destination` on `https://api.hanzo.ai/v1/mcp`	4 operations, 1 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/destination, operation get_destination:

CLI

SDK

HTTP

MCP

hanzo destination list

.ts

.py

.go

.rs

.java

import { Configuration, DestinationApi } from 'hanzoai';

const api = new DestinationApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getDestination();

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

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = DestinationApi(client).get_destination()

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

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

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

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

let result = destination_api::get_destination(&cfg, Default::default()).await?;

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

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

var result = new DestinationApi(client).getDestination();

curl https://api.hanzo.ai/v1/destination \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches destination through the destination tool, which names its 4 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_destinations"
         }
       }
     }'

Answers 200 with object — ok.

Endpoints

Endpoint	What it does
`POST /v1/destination/{platform}/test`	Sends ONE synthetic conversion through the connected destination end to end and reports what the platform said.
`GET /v1/destination/{platform}`	Reports one destination's card for the caller's org — its config fields, its connection state, and whether a credential resolves right now.
`POST /v1/destination/{platform}`	Connect one conversion destination for your org, or update the one you have
`DELETE /v1/destination/{platform}`	Forgets a destination for the caller's org: every credential held in KMS, then the stored config.
`GET /v1/destination`	Reports every destination this deployment can forward to, each with the caller org's connection state: whether it is connected, whether it is enabled, whether a credential resolves right now, and the config fields the console renders for it.

All Hanzo APIs · Interactive reference

Was this page useful?

PreviousChannel NextProvider