API Reference
Hanzo MQ API
Hanzo MQ provides a managed message queue and pub/sub service built on
Hanzo MQ provides a managed message queue and pub/sub service built on
bearerAuth — HTTP bearerBearerAuth — HTTP bearer
All Hanzo APIs share one bearer credential and common error and pagination conventions. See API conventions.
curl -H "Authorization: Bearer $HANZO_API_KEY" https://mq.hanzo.ai
| Method | Endpoint | Description |
|---|
GET | /v1/mq/accounts | List accounts |
GET | /v1/mq/accounts/{id} | Get account info |
GET | /v1/mq/accounts/{id}/connections | List account connections |
| Method | Endpoint | Description |
|---|
GET | /v1/mq/streams/{stream}/consumers | List consumers |
POST | /v1/mq/streams/{stream}/consumers | Create consumer |
GET | /v1/mq/streams/{stream}/consumers/{name} | Get consumer info |
DELETE | /v1/mq/streams/{stream}/consumers/{name} | Delete consumer |
POST | /v1/mq/streams/{stream}/consumers/{name}/next | Pull next message(s) |
| Method | Endpoint | Description |
|---|
GET | /v1/mq/health | Health check |
GET | /v1/mq/info | Server info |
| Method | Endpoint | Description |
|---|
GET | /v1/mq/kv | List KV buckets |
POST | /v1/mq/kv | Create KV bucket |
GET | /v1/mq/kv/{bucket} | Get bucket info |
DELETE | /v1/mq/kv/{bucket} | Delete bucket |
GET | /v1/mq/kv/{bucket}/keys | List keys in bucket |
GET | /v1/mq/kv/{bucket}/{key} | Get value |
PUT | /v1/mq/kv/{bucket}/{key} | Put value |
DELETE | /v1/mq/kv/{bucket}/{key} | Delete key |
GET | /v1/mq/kv/{bucket}/{key}/history | Get key history |
GET | /v1/mq/kv/{bucket}/watch | Watch bucket changes via SSE |
| Method | Endpoint | Description |
|---|
GET | /v1/mq/objects | List object stores |
POST | /v1/mq/objects | Create object store |
GET | /v1/mq/objects/{store} | Get store info |
DELETE | /v1/mq/objects/{store} | Delete object store |
GET | /v1/mq/objects/{store}/list | List objects in store |
GET | /v1/mq/objects/{store}/{name} | Download object |
PUT | /v1/mq/objects/{store}/{name} | Upload object |
DELETE | /v1/mq/objects/{store}/{name} | Delete object |
| Method | Endpoint | Description |
|---|
POST | /v1/mq/publish | Publish message to subject |
POST | /v1/mq/request | Request/reply pattern |
| Method | Endpoint | Description |
|---|
GET | /v1/mq/streams | List streams |
POST | /v1/mq/streams | Create stream |
GET | /v1/mq/streams/{name} | Get stream info |
PUT | /v1/mq/streams/{name} | Update stream config |
DELETE | /v1/mq/streams/{name} | Delete stream |
POST | /v1/mq/streams/{name}/purge | Purge stream messages |
GET | /v1/mq/streams/{name}/messages | Get stream messages |
DELETE | /v1/mq/streams/{name}/messages/{seq} | Delete specific message |
| Method | Endpoint | Description |
|---|
GET | /v1/mq/subjects | List active subjects |
GET | /v1/mq/subjects/{subject}/info | Get subject info |
| Method | Endpoint | Description |
|---|
GET | /v1/mq/subscribe/{subject} | Subscribe to subject via SSE |
Hanzo MQ API guide · All Hanzo APIs · OpenAPI spec
How is this guide?