Skip to content
Console
Menu

Getting Started

Authentication

KV Store

History in Channels

Lists a channel's messages after a cursor, oldest first.

Lists a channel's messages after a cursor, oldest first. With wait_seconds, an empty result waits up to that long for the first new message and answers as soon as one arrives: this is how an agent subscribes.

Not available yet. Sylphx Realtime is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.

  • Path GET https://api.realtime.sylphx.com/v1/channels/channel/messages
  • Scope realtime:read
  • Effect read — nothing is written.
  • Collection channels
  • Query cursor, page_size, wait_seconds
  • Host https://api.realtime.sylphx.com

#Request

FieldTypeWhat it is
channelstringThe channel, namespace:name. Required.
cursorstringReturn messages after this cursor. Empty starts at the oldest kept message.
page_sizeint32At most this many messages; default 100, at most 1,000.
wait_secondsint32When no message is after the cursor, wait up to this many seconds for one; 0 to 30, default 0 (answer at once).

#Response

FieldTypeWhat it is
messagesMessage[]The messages, oldest first. Empty when the wait ran out.
next_cursorstringThe cursor to pass as cursor next. Always set unless the namespace is ephemeral.

#Message

FieldTypeWhat it is
channelstringThe channel, namespace:name.
cursorstringThe message's cursor: opaque, ordered within the channel, and the value to resume from. Empty in an ephemeral namespace.
eventstringThe application's event name, for example move. 1 to 64 characters.
datavalueThe JSON payload, at most 64 KiB encoded.
publisherstringThe user id of the publisher; empty when a server published without one.
publish_timetimestampWhen the service accepted the message.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.realtime.sylphx.com/v1/channels/channel/messages" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"