Hanzo

Ad

Package ads is your paid ad campaigns, launched and paused from one place.

Package ads is your paid ad campaigns, launched and paused from one place.

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

Specification

Specification pending — no HIP in hanzoai/hips declares capability: ad 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
RESTad at its own prefix7 operations
CLIhanzo ads …7 of 7
SDKno published client declares one yet — regenerating the clients is what adds them
MCPtool ads on https://api.hanzo.ai/v1/mcp7 operations, 0 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/ad/summary, operation get_ad_summary:

hanzo ads summary

Answers 200 with object — ok.

Endpoints

EndpointWhat it does
POST /v1/ad/campaigns/{id}/launchRun one of your stored campaigns on its ad network
GET /v1/ad/campaigns/{id}Returns one of the caller org's campaigns.
PUT /v1/ad/campaigns/{id}Replaces the user-owned fields of one of the caller org's campaigns and answers the stored row.
DELETE /v1/ad/campaigns/{id}Removes one of the caller org's campaigns and answers 204 with no body.
GET /v1/ad/campaignsReturns the caller org's ad campaigns, most recently updated first, optionally narrowed to one lifecycle status.
POST /v1/ad/campaignsRegisters a new ad campaign for the caller's org and answers 201 with the stored row.
GET /v1/ad/summaryRolls the caller org's ad campaigns up into four numbers: how many campaigns exist, how many are active, and the summed budget and spend across all…

All Hanzo APIs · Interactive reference

How is this guide?

On this page