API Reference
Hanzo KV API
Hanzo KV provides a managed key-value store with caching, pub/sub messaging,
Hanzo KV provides a managed key-value store with caching, pub/sub messaging,
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://kv.hanzo.ai
| Method | Endpoint | Description |
|---|
GET | /v1/kv/clusters | List KV clusters |
POST | /v1/kv/clusters | Create KV cluster |
GET | /v1/kv/clusters/{id} | Get cluster |
PUT | /v1/kv/clusters/{id} | Update cluster |
DELETE | /v1/kv/clusters/{id} | Delete cluster |
GET | /v1/kv/clusters/{id}/stats | Get cluster stats |
| Method | Endpoint | Description |
|---|
GET | /v1/kv/hash/{key} | Get all hash fields |
PUT | /v1/kv/hash/{key} | Set hash fields |
GET | /v1/kv/hash/{key}/{field} | Get hash field |
DELETE | /v1/kv/hash/{key}/{field} | Delete hash field |
| Method | Endpoint | Description |
|---|
GET | /health | Health check |
| Method | Endpoint | Description |
|---|
GET | /v1/kv/keys | Scan keys |
GET | /v1/kv/keys/{key} | Get key value |
PUT | /v1/kv/keys/{key} | Set key value |
DELETE | /v1/kv/keys/{key} | Delete key |
PUT | /v1/kv/keys/{key}/ttl | Set key TTL |
POST | /v1/kv/keys/{key}/incr | Increment numeric key |
POST | /v1/kv/batch | Batch get/set/delete |
| Method | Endpoint | Description |
|---|
GET | /v1/kv/list/{key} | Get list range |
POST | /v1/kv/list/{key}/push | Push to list |
POST | /v1/kv/list/{key}/pop | Pop from list |
| Method | Endpoint | Description |
|---|
GET | /v1/kv/namespaces | List namespaces |
POST | /v1/kv/namespaces | Create namespace |
GET | /v1/kv/namespaces/{name} | Get namespace |
DELETE | /v1/kv/namespaces/{name} | Delete namespace and all keys |
| Method | Endpoint | Description |
|---|
POST | /v1/kv/pubsub/publish | Publish message to channel |
GET | /v1/kv/pubsub/subscribe | Subscribe to channels (SSE) |
GET | /v1/kv/pubsub/channels | List active channels |
| Method | Endpoint | Description |
|---|
GET | /v1/kv/streams/{key} | Read stream entries |
POST | /v1/kv/streams/{key}/add | Add entry to stream |
GET | /v1/kv/streams/{key}/info | Get stream info |
Hanzo KV API guide · All Hanzo APIs · OpenAPI spec
How is this guide?