AsyncAPI channel · Pypestream · Pypestream Engagement API WebSocket

chat:{CHAT_ID}

Phoenix Channels topic joined with the access token returned by the Create User (anonymous_session) request. Join before starting the engagement to avoid missing the microapp's initial messages.

Open source AsyncAPI → All Pypestream channels Pypestream provider profile
Provider: Pypestream AsyncAPI: v3.0.0 Spec: Pypestream Engagement API WebSocket Operations: 10 Messages: 10

Channel address

chat:{CHAT_ID}

Parameters

Operations

send
sendChatStart
receive
receiveChatReady
send
sendPing
receive
receivePong
send
sendMessage
receive
receiveIncomingMessage
receive
receiveIncomingNotice
send
sendChatEnd
send
sendChatSnapshot
receive
receiveChatSnapshotResponse

Messages

chat:start
Client. Starts the engagement. After sending this event the client must wait for chat:ready.
Content-Type:
chat:ready
Pypestream. Informs the client the chat is ready to receive send_message requests. A message sent before this event is rejected with a 428 status.
Content-Type:
new:ping
Client. Resets the connection timeout counter. Must be sent every 20 seconds to prevent disconnection.
Content-Type:
new:pong
Pypestream. Response to new:ping.
Content-Type:
msg:send
Client. A message transmitted from the end-user to the microapp.
Content-Type:
incoming:msg
Pypestream. A message transmitted from the microapp to the end-user.
Content-Type:
incoming:notice
Pypestream. Enables a microapp to send a notice to the end-user of the chat.
Content-Type:
chat:end
Client. Terminates the chat established between the end-user and the microapp.
Content-Type:
chat:snapshot
Client. A request for a snapshot of the engagement as it currently stands.
Content-Type:
chat:snapshot_response
Pypestream. An object with all the relevant information of the engagement at the moment the request was made.
Content-Type:

About AsyncAPI

The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.

Browse every event-driven channel on the APIs.io network or compare with the broader Agent Skill and MCP server surfaces of the same providers.

Work with this as data

Every channel here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for event channels

4 MCP tools reach this
  • find_channelsBrowse and filter every channel in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This channel 
curl "https://apis.io/api/v1/channels/chat-chat-id"
All event channels 
curl "https://apis.io/api/v1/channels?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.