/
/AstrBot OpenAPI v1
ChangesDocsSign in
Sign in
  • APIs
  • Generators
  • Stacks
  • Projects
  • Docs
  • History
  • Schema
Checked 8m ago · Updated 1w ago
Bot Config Routes4
Bots15
Chat28
  • postSend a webchat message
  • getOpen a streaming chat WebSocket
  • getList webchat sessions
  • getCreate a webchat session
  • postDelete multiple webchat sessions
  • getGet a webchat session and its messages
  • deleteDelete a webchat session
  • patchUpdate a webchat session
  • postStop active webchat work for a session
  • getResume an active webchat run as an SSE stream
  • patchUpdate the latest user message in a webchat session
  • postRegenerate a bot message in a webchat session
  • getList chat-selectable configuration profiles
  • postCreate or reuse a side thread from a webchat message
  • getGet a webchat side thread
  • deleteDelete a webchat side thread
  • postSend a message inside a webchat side thread
  • getList ChatUI projects
  • postCreate a ChatUI project
  • getGet a ChatUI project
  • deleteDelete a ChatUI project
  • patchUpdate a ChatUI project
  • getList sessions in a ChatUI project
  • getList files in a ChatUI project workspace directory
  • getRead a file in a ChatUI project workspace
  • getDownload a file from a ChatUI project workspace
  • postAdd a session to a ChatUI project
  • deleteRemove a session from its ChatUI project
Config Profiles7
Conversations8
Files5
IM2
MCP11
Open API2
Personas15
Plugin Pages12
Plugin Sources5
Plugins40
Provider Sources10
Providers19
Sessions11
Skills24
Subagents3
System Config4
T2I8
    Chat

    Open a streaming chat WebSocket

    Required scope: chat

    Conditional sensitive scope: chat:admin

    get/api/v1/chat/ws

    Query parameters

    api_keystring
    keystring

    Changes