Repository navigation
Describe the sockets at the API's addresses, a voice call's socket and the Recorder's topic - #1618
Open
davidmckayv wants to merge 2 commits into
Open
davidmckayv wants to merge 2 commits into
davidmckayv wants to merge 2 commits into
Conversation
davidmckayv
requested review from
MikeRyanDev,
dustywusty,
guidovizoso,
mxmzb,
samjulien and
tylerslaton
as code owners
November 14, 2026 15:18
…d the Recorder's topic
Conversation events, a Bot's screen and its terminal get the plain channel names at their addresses
under /api/v2/organizations/{organizationId}, signed in to by a session, an API key or an app's
access token; the addresses they had before stay described as the legacy channels. A voice call on
the voice service's realtime socket and the Recorder's trajectory topic on the gateway are described
too, and a call over WebRTC is said to be outside what AsyncAPI describes.
davidmckayv
force-pushed
the
api/asyncapi-v2-addresses
branch
from
November 14, 2026 15:28
3008933 to
64b78db
Compare
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Stacked on #1616; its base moves to main when that merges.
What
/api/v2/organizations/{organizationId}/conversation-events,/computers/{botId}/screenand/computers/{botId}/terminal, as the channelsconversationEvents,botScreenandbotTerminal. The addresses they have had until now stay described as thelegacychannels, with the same messages.Authorization: Beareron the request that opens it. An app's token needsconversations:readfor conversation events andcomputers:readfor a Bot's computer; withoutcomputers:writeit watches only, and its input is answered with the socket's own error message.trajectory:{trajectoryId}topic on the gateway's socket: join, batches of events, and the reply to each.Checks
bun run api:lintpasses, and the AsyncAPI CLI's ownvalidateaccepts the file.Tested
Against a running OpenBot that serves these addresses, with Intelligence 0.16.0-rc.13, in Chromium and in headless WebKit: conversation events and a Bot's screen opened at the API's addresses from a signed-in page carry the messages this file gives them, beside the legacy addresses the web app opens today. The bearer sign-in and the watch-only rule are tested on the server with real tokens.
Merge order
This describes addresses a server serves from its next build, so it merges once that build is on the server's main. The three scopes also need adding to the REST spec's OAuth scheme, which is with that file's owner.