v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0172165343.2 KB

Msgs

Stream Receive

Receives messages from a topic using a consumer group.

Each consumer in the group reads from all partitions. Messages are locked by leases for the specified duration to prevent duplicate delivery within the same consumer group.

post/api/v1.msgs.stream.receive

Request body

namespacestring nullable

topicstring required

consumer_groupstring required

batch_sizeinteger

lease_duration_msinteger

default_starting_position'earliest' | 'latest'

batch_wait_msinteger nullable

Maximum time (in milliseconds) to wait for messages before returning.

Example request

{
  "namespace": "some_namespace",
  "topic": "some_topic_name",
  "consumer_group": "some_consumer_group"
}

Response

Example response

{
  "msgs": [
    {
      "topic": "some_topic_name~0"
    }
  ]
}