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"
    }
  ]
}

Changes

Changed in 9 of the 53 revisions of this API.141926

Apr 28, 2026a542ced3f5931212See the full diff
- ●
  added the new invalid-input enum value to the type response property for the response status 400
  response-property-enum-value-added
- ●
  added the new invalid-input enum value to the type response property for the response status 401
  response-property-enum-value-added
- ●
  added the new invalid-input enum value to the type response property for the response status 403
  response-property-enum-value-added
- ●
  added the new invalid-input enum value to the type response property for the response status 422
  response-property-enum-value-added
- ●
  added the new operation-error enum value to the type response property for the response status 400
  response-property-enum-value-added
- ●
  added the new operation-error enum value to the type response property for the response status 401
  response-property-enum-value-added
- ●
  added the new operation-error enum value to the type response property for the response status 403
  response-property-enum-value-added
- ●
  added the new operation-error enum value to the type response property for the response status 422
  response-property-enum-value-added
- ●
  added the new server-error enum value to the type response property for the response status 400
  response-property-enum-value-added
- ●
  added the new server-error enum value to the type response property for the response status 401
  response-property-enum-value-added
- ●
  added the new server-error enum value to the type response property for the response status 403
  response-property-enum-value-added
- ●
  added the new server-error enum value to the type response property for the response status 422
  response-property-enum-value-added
- ○
  removed the invalid_input enum value from the type response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the invalid_input enum value from the type response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the invalid_input enum value from the type response property for the response status 403
  response-property-enum-value-removed
- ○
  removed the invalid_input enum value from the type response property for the response status 422
  response-property-enum-value-removed
- ○
  removed the operation_error enum value from the type response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the operation_error enum value from the type response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the operation_error enum value from the type response property for the response status 403
  response-property-enum-value-removed
- ○
  removed the operation_error enum value from the type response property for the response status 422
  response-property-enum-value-removed
- ○
  removed the server_error enum value from the type response property for the response status 400
  response-property-enum-value-removed
- ○
  removed the server_error enum value from the type response property for the response status 401
  response-property-enum-value-removed
- ○
  removed the server_error enum value from the type response property for the response status 403
  response-property-enum-value-removed
- ○
  removed the server_error enum value from the type response property for the response status 422
  response-property-enum-value-removed
Apr 28, 2026b1d873e9a6e44See the full diff
- ○
  added the required property type to the response with the 400 status
  response-required-property-added
- ○
  added the required property type to the response with the 401 status
  response-required-property-added
- ○
  added the required property type to the response with the 403 status
  response-required-property-added
- ○
  added the required property type to the response with the 422 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 21, 2026c3022218176815See the full diff
- ▲
  the detail response's property type/format changed from array/ to string/ for status 422
  response-property-type-changed
- ○
  added the optional property location to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property location to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property location to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property location to the response with the 422 status
  response-optional-property-added
- ○
  added the required property code to the response with the 422 status
  response-required-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 14, 20267f5edfb12f871See the full diff
- ▲
  the namespace request property's minLength was increased from 0 to 1
  request-property-min-length-increased
Apr 14, 202614bcce06404b11See the full diff
- ▲
  added the pattern ^[a-zA-Z0-9\-/_.=+]+$ to the request property namespace
  request-property-pattern-added
- ●
  the namespace request property's maxLength was set to 256
  request-property-max-length-set
Apr 13, 2026e6c44b12ecfb2See the full diff
- ▲
  the msgs/items/scheduled_at response's property type/format changed from string/date-time to integer/uint64 for status 200
  response-property-type-changed
- ▲
  the msgs/items/timestamp response's property type/format changed from string/date-time to integer/uint64 for status 200
  response-property-type-changed
Apr 10, 20264bfee3499c4c2See the full diff
- ○
  the response property msgs/items/headers became required for the status 200
  response-property-became-required
- ○
  the headers response's property default value {} was removed for the status 200
  response-property-default-value-removed
Mar 31, 2026cb1523fc3cdd2See the full diff
- ●
  the batch_wait_ms request property's min was set to 0.00
  request-property-min-set
- ●
  the lease_duration_ms request property's min was set to 0.00
  request-property-min-set
Mar 31, 2026f62be26d2a53943See the full diff
- ▲
  the response property msgs/items/headers became optional for the status 200
  response-property-became-optional
- ▲
  the detail response's property type/format changed from string/ to array/ for status 422
  response-property-type-changed
- ▲
  the msgs/items/scheduled_at response's property type/format changed from integer/uint64 to string/date-time for status 200
  response-property-type-changed
- ▲
  the msgs/items/timestamp response's property type/format changed from integer/uint64 to string/date-time for status 200
  response-property-type-changed
- ▲
  removed the required property code from the response with the 422 status
  response-required-property-removed
- ▲
  removed the required property type from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property type from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property type from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property type from the response with the 422 status
  response-required-property-removed
- ●
  removed the optional property location from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property location from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property location from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property location from the response with the 422 status
  response-optional-property-removed
- ○
  the namespace request property's minLength was decreased from 1 to 0
  request-property-min-length-decreased
- ○
  removed the pattern ^[a-zA-Z0-9\-/_.=+]+$ from the request property namespace
  request-property-pattern-removed
- ○
  the headers response's property default value {} was added for the status 200
  response-property-default-value-added
This revision also has 35 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history