Hanzo
API Reference

Hanzo Stream API

Hanzo Stream is a Kafka-compatible streaming gateway built on Hanzo PubSub.

Hanzo Stream is a Kafka-compatible streaming gateway built on Hanzo PubSub.

Hanzo Stream API · Guide & examples → · All API references →

Base URLhttps://stream.hanzo.ai
Version1.0.0
Operations14
GuideHanzo Stream API guide

Authentication

  • bearerAuth — HTTP bearer
  • BearerAuth — 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://stream.hanzo.ai

Endpoints

Brokers

MethodEndpointDescription
GET/v1/stream/brokersList broker instances
GET/v1/stream/brokers/configGet broker configuration

Consumer Groups

MethodEndpointDescription
GET/v1/stream/groupsList consumer groups
GET/v1/stream/groups/{group_id}Get consumer group details
DELETE/v1/stream/groups/{group_id}Delete a consumer group
GET/v1/stream/groups/{group_id}/offsetsGet committed offsets
PUT/v1/stream/groups/{group_id}/offsetsCommit offsets

Health

MethodEndpointDescription
GET/healthHealth check

Messages

MethodEndpointDescription
GET/v1/stream/topics/{topic}/messagesConsume messages
POST/v1/stream/topics/{topic}/messagesProduce messages

Topics

MethodEndpointDescription
GET/v1/stream/topicsList topics
POST/v1/stream/topicsCreate a topic
GET/v1/stream/topics/{topic}Get topic metadata
DELETE/v1/stream/topics/{topic}Delete a topic

Hanzo Stream API guide · All Hanzo APIs · OpenAPI spec

How is this guide?

On this page

AuthenticationEndpointsBrokersConsumer GroupsHealthMessagesTopics