Class StreamsAPI

Create stream

const stream = await client.streams.create({
  externalId: 'my_stream',
  settings: {
    template: {
      name: 'ImmutableTestStream'
    }
  }
});
Copy

Delete a stream

Deletes a stream by its identifier, along with all records stored in the stream. If the stream does not exist, the operation succeeds without error (idempotent delete).

await client.streams.delete('my_stream');
Copy

List streams

const streams = await client.streams.list();
Copy

Retrieve a stream

const stream = await client.streams.retrieve({
  externalId: 'my_stream',
  includeStatistics: true
});
Copy