Skip to content

API Reference

All Bot API interfaces with their routes, request/response types, and versioning status. Every request requires Authorization: Bot <token> header.

14 interfaces · 37 routes

IArchetypes

v1 stable
3 routes

List and inspect archetypes (roles) in a space. Permissions are hidden unless the bot has ManageArchetype entitlement.

GET /Get GET /List GET /ListMembers

IBotSelf

v1 stable
2 routes

Get information about the authenticated bot and its spaces.

GET /GetMe GET /GetSpaces

ICalls

v20260401 draft
3 routes

Receive and manage incoming calls. Verified bots only.

POST /Accept POST /Reject GET /Ringing

IChannels

v1 stable
3 routes

Create, list, and delete channels within a space.

POST /Create DELETE /Delete GET /List

ICommands

v1 stable
5 routes

Register, update, list, and delete slash commands for your bot.

DELETE /Delete GET /List GET /ListForSpace POST /Register PATCH /Update

IEvents

v1 stable
1 route

Subscribe to real-time events via Server-Sent Events (SSE). Receive messages, member changes, voice activity, and more.

GET /Stream

IInteractions

v1 stable
5 routes

Respond to slash-command, control, and select interactions. Supports ack, defer, modal, reply, and edit.

POST /Ack POST /Defer PATCH /EditMessage POST /Modal POST /Reply

IMembers

v1 stable
1 route

Manage space members: kick users from channels.

POST /Kick

IMessages

v1 stable
2 routes

Send messages and retrieve message history from channels.

GET /History POST /Send

IReactions

v1 stable
4 routes

Add and remove emoji reactions on messages.

POST /Add POST /BatchGet GET /List DELETE /Remove

ISpaces

v1 stable
3 routes

Get space details and member information.

GET /Get GET /GetMember GET /ListMembers

ITyping

v1 stable
2 routes

Send typing indicators to channels. Typing status automatically expires after 8 seconds.

POST /Start POST /Stop

IVoice

v1 stable
1 route

Get voice streaming tokens for audio ingress. Bots stream Opus audio directly to a WebSocket endpoint — no WebRTC needed.

POST /StreamToken

IVoiceEgress

v20260401 draft
2 routes

Subscribe to individual voice tracks for audio egress. Verified bots only.

POST /SubscribeTrack DELETE /UnsubscribeTrack