Pipeline output

Read multiple pipeline outputs

Changed on Oct 9, 2026

Reads events from multiple existing pipeline output streams. By default, the endpoint uses long polling (timeout: 5s) and returns as soon as at least one event is available (min_events: 1).

post/serve-multi

Request

Base URL
https://tenzir.com/api/v0
Auth
API key in header X-Tenzir-Token
TypeScript
https://skmtc.dev/tenzir/apis/tenzir-rest-api/docs/serve-multi/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

max_eventsinteger

The maximum number of events to return across all requested output streams. The limit is split evenly across streams and rounded up when necessary.

min_eventsinteger

The minimum number of events to wait for across all requested output streams before returning. The limit is split evenly across streams and rounded up when necessary.

timeoutstring

The maximum time to spend on the request. Reaching the timeout returns the available events and is not an error. The timeout must not be greater than 10 seconds.

schema'exact' | 'never' | 'name_and_type'

The default schema representation to include in each response. Use never to omit definitions, or name_and_type to report names and structural type IDs. Individual output streams can override this with their own schema field.

Example request

{
  "requests": [
    {
      "serve_id": "query-1",
      "continuation_token": "340ce2j",
      "schema": "exact"
    }
  ],
  "max_events": 1024,
  "min_events": 1,
  "timeout": "200ms",
  "schema": "exact"
}

Response

The response contains one entry for each requested output stream.

object required

Changes

Oct 9, 20268d8743b1f7f2 Revision changes
- info
  added the new name_and_type enum value to the request property //
- info
  added the new name_and_type enum value to the request property
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
Oct 7, 202628cb75a25674 Revision changes
- breaking
  removed the enum value legacy of the request property //
- breaking
  removed the enum value legacy of the request property
- info
  the request property default value changed from legacy to exact

Operation history