Skip to content
Console
Menu

Getting Started

Authentication

KV Store

Channels

The `channels` collection of Sylphx Realtime.

The channels collection of Sylphx Realtime — served at https://api.realtime.sylphx.com.

Service Sylphx Realtime · served at https://api.realtime.sylphx.com

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

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
POSTpublishPublishes a message to a channel. The namespace must exist. The server publishes regardless of client_publish. A repeated Sylphx-Effect-Id publishes once.
GEThistoryLists 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.
GETpresenceLists who is present on a channel.

#publish

Publishes a message to a channel. The namespace must exist. The server publishes regardless of client_publish. A repeated Sylphx-Effect-Id publishes once.

POST https://api.realtime.sylphx.com/v1/channels:publish · scope realtime:publish · effect write · not available yet · Request, response and examples

#history

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.

GET https://api.realtime.sylphx.com/v1/channels/channel/messages · scope realtime:read · effect read · not available yet · Request, response and examples

#presence

Lists who is present on a channel.

GET https://api.realtime.sylphx.com/v1/channels/channel/presence · scope realtime:read · effect read · not available yet · Request, response and examples