Delete a value from a stream
group_idstring*required
Group within the stream that owns the item.
item_idstring*required
Identifier of the item to delete.
stream_namestring*required
Name of the stream that owns the item.
old_valueunknown
The value before the update (None if key didn't exist)
Get a value from a stream
group_idstring*required
Group within the stream to read from.
item_idstring*required
Identifier of the item to fetch.
stream_namestring*required
Name of the stream to read from.
List all items in a stream group
group_idstring*required
Group within the stream whose items should be listed.
stream_namestring*required
Name of the stream whose items should be listed.
List all available stream with metadata
countinteger· uint*requiredmin 0
stream::list_groups
functionList all groups in a stream
stream_namestring*required
Name of the stream whose groups should be listed.
Send a custom event to stream subscribers
dataunknown*required
JSON payload delivered to subscribers.
group_idstring*required
Group within the stream to broadcast to.
idstring
Optional subscriber ID to target a single subscriber instead of the whole group.
stream_namestring*required
Name of the stream to broadcast to.
typestring*required
Event type label sent alongside the payload.
Set a value in a stream
dataunknown*required
JSON value to store at the given location.
group_idstring*required
Group within the stream that owns the item.
item_idstring*required
Identifier of the item within the group.
stream_namestring*required
Name of the stream that owns the item.
new_valueunknown*required
The value after the update
old_valueunknown
The value before the update (None if key didn't exist)
Atomically update a stream value with multiple operations
group_idstring*required
Group within the stream that owns the item.
item_idstring*required
Identifier of the item to update.
opsunknown[]*required
Ordered list of update operations applied atomically to the existing value.
stream_namestring*required
Name of the stream that owns the item.
errorsunknown[]
Errors encountered while applying ops. Successfully applied ops are still reflected in `new_value`. Field is omitted from JSON when empty for backward compatibility.
new_valueunknown*required
The value after the update
old_valueunknown
The value before the update (None if key didn't exist)