v12

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0223257199.4 KB

Chat

Send a webchat message

Required scope: chat

Conditional sensitive scope: chat:admin

post/api/v1/chat

usernamestring

Caller-declared WebChat sender/session owner. Configured AstrBot administrator IDs require the chat:admin API key sub-scope.

session_idstring

conversation_idstring

Deprecated alias for session_id.

config_idstring

config_namestring

selected_providerstring

selected_modelstring

enable_streamingboolean

Deprecated compatibility field. It is used only when flags.enable_streaming is absent; otherwise flags.enable_streaming takes priority.

_skip_user_historyboolean

Internal WebUI flag for edit/regenerate flows.

_llm_checkpoint_idstring

Internal WebUI checkpoint override.

_platform_history_idstring

Internal WebUI platform history override.

_thread_selected_textstring

Internal WebUI side-thread context.

Standard AstrBot success response

status'ok' required

messagestring

{"stackTrail":"components:schemas:SuccessEnvelope:properties:data","oasType":"schema","type":"unknown"}