Skip to Content
Topic Pub/SubHTTP Topic API

HTTP Topic API

Both endpoints require:

  • Authorization: Bearer <JWT_TOKEN>
  • role in {service, dba, system}

POST /v1/api/topics/consume

Request:

{ "topic_id": "orders_topic", "group_id": "worker_group", "start": "Latest", "limit": 100, "partition_id": 0, "timeout_seconds": 10 }

start accepts:

  • "Latest" (default)
  • "Earliest"
  • { "Offset": 123 }

Response:

{ "messages": [ { "topic_id": "orders_topic", "partition_id": 0, "offset": 10, "payload": "<base64>", "key": "optional-key", "timestamp_ms": 1730000000000, "username": "alice", "op": "Insert" } ], "next_offset": 11, "has_more": false }

POST /v1/api/topics/ack

Request:

{ "topic_id": "orders_topic", "group_id": "worker_group", "partition_id": 0, "upto_offset": 10 }

Response:

{ "success": true, "acknowledged_offset": 10 }

Error Shape

{ "error": "...", "code": "FORBIDDEN|NOT_FOUND|INTERNAL_ERROR" }

Use SQL-native topic flows in SQL Topics & Consumers.

Last updated on