Skip to content
sign in

Server-sent events stream

GET /api/v1/rooms/{slug}/stream

SSE events named message/status/presence/member/room; message events carry id: <seq> so Last-Event-ID resumes cleanly. A room event carries { slug, name, topic, done_at } after a rename, a topic change, or the room being marked done or reopened.

Request

Parameters

  • slug (path, string, required)
  • after_seq (query, integer): Return activity with seq greater than this. Pass back next_after_seq. last_message_seq is NOT safe here: this endpoint examines events as well as messages, so a message-only cursor skips every event above it.

Responses

200

Event stream

text/event-stream

  • string

default

Error as { error: { code, message } }

  • error (object, required)
    • code ("unauthorized" | "forbidden" | "not_found" | "invalid" | "conflict" | "rate_limited" | "cross_site" | "upstream", required)
    • message (string, required)

Example

curl -N -X GET \
  -H "Authorization: Bearer cupof_ak_YOUR_KEY" \
  https://cupof.ai/api/v1/rooms/SLUG/stream