/
AS
astrbotdevs
/
AstrBot OpenAPI v1
Search skmtc…
⌘K
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Subscribe
v12
latest
OpenAPI 3.1.0
raw.githubusercontent.com
2026-08-02
232
57
199.4 KB
System Config
Get the system configuration schema
Required scope:
config
get
/api/v1/system-config/schema
Response
Standard AstrBot success response
SuccessEnvelope
required
status
'ok'
required
message
string
{"stackTrail":"components:schemas:SuccessEnvelope:properties:data","oasType":"schema","type":"unknown"}
All 232 operations
get
Get the system configuration schema
get
Get the system configuration
put
Replace the system configuration
get
Get runtime-enriched system configuration metadata
get
Get the configuration profile schema
get
List configuration profiles
post
Create a configuration profile
get
Get a configuration profile
put
Replace a configuration profile
delete
Delete a configuration profile
patch
Rename a configuration profile
get
List UMO to configuration profile bindings
put
Replace all UMO to configuration profile bindings
put
Bind a UMO to a configuration profile
delete
Remove a UMO configuration profile binding
get
List configurable bot types and their schemas
post
Run a bot type registration flow action
get
List created bots and their configurations
post
Create a bot from configuration
get
List runtime status for all bots
get
Get a bot configuration by query ID
put
Replace a bot configuration by body ID
delete
Delete a bot by query ID
patch
Enable or disable a bot by body ID
post
Test a bot registration or connection by body ID
get
Get a bot configuration
put
Replace a bot configuration
delete
Delete a bot
patch
Enable or disable a bot
post
Test a bot registration or connection
get
Get the overall provider configuration schema
get
List provider sources
post
Create a provider source
get
Get a provider source by query ID
put
Update a provider source by body ID
delete
Delete a provider source by query ID
get
List models available from a provider source by query ID
get
List providers under a provider source by query ID
post
Create a provider under a provider source by body ID
get
Get a provider source
put
Update a provider source or create it if missing
delete
Delete a provider source and providers that reference it
get
List models available from a provider source
get
List providers under a provider source
post
Create a provider under a provider source
get
List providers by capability or source
post
Create a standalone provider
get
Get a provider configuration by query ID
put
Replace a provider configuration by body ID
delete
Delete a provider by query ID
patch
Enable or disable a provider by body ID
post
Test a provider by body ID
post
Probe embedding dimension for a provider by body ID
get
Get a provider configuration
put
Replace a provider configuration
delete
Delete a provider
patch
Enable or disable a provider
post
Test a provider
post
Probe embedding dimension for a provider
post
Send a webchat message
get
Open a streaming chat WebSocket
get
List webchat sessions
get
Create a webchat session
post
Delete multiple webchat sessions
get
Get a webchat session and its messages
delete
Delete a webchat session
patch
Update a webchat session
post
Stop active webchat work for a session
get
Resume an active webchat run as an SSE stream
patch
Update the latest user message in a webchat session
post
Regenerate a bot message in a webchat session
get
List chat-selectable configuration profiles
post
Create or reuse a side thread from a webchat message
get
Get a webchat side thread
delete
Delete a webchat side thread
post
Send a message inside a webchat side thread
get
List ChatUI projects
post
Create a ChatUI project
get
Get a ChatUI project
delete
Delete a ChatUI project
patch
Update a ChatUI project
get
List sessions in a ChatUI project
get
List files in a ChatUI project workspace directory
get
Read a file in a ChatUI project workspace
get
Download a file from a ChatUI project workspace
post
Add a session to a ChatUI project
delete
Remove a session from its ChatUI project
post
Send a message to a UMO
get
List active IM bot IDs
post
Upload a file
get
Download an uploaded file by attachment ID
post
Upload a file
get
Get an uploaded file by stored filename
get
Get attachment metadata
delete
Delete an attachment
get
Download attachment content
get
List installed plugins
get
Get plugin details by query ID
delete
Uninstall a plugin by query ID
get
Get plugin configuration by query ID
put
Save plugin configuration by body ID
get
Get plugin configuration schema by query ID
get
List uploaded files for a plugin file configuration item by query ID
post
Upload files for a plugin file configuration item by query ID
delete
Delete a plugin file configuration upload by query ID
get
Get plugin README content by query ID
get
Get plugin CHANGELOG content by query ID
post
Reload a plugin by body ID
patch
Enable or disable a plugin by body ID
get
List plugin pages by query ID
get
Get plugin page entry HTML by query ID
get
Get a plugin page asset by query ID
get
Get plugin details
delete
Uninstall a plugin
get
Get plugin configuration
put
Save plugin configuration
put
Set plugin log level
get
Get plugin configuration schema
get
List uploaded files for a plugin file configuration item
post
Upload files for a plugin file configuration item
delete
Delete a plugin file configuration upload
get
Get plugin README content
get
Get plugin CHANGELOG content
post
Reload a plugin
post
Bind an installed plugin to a marketplace source
patch
Enable or disable a plugin
post
Update or reinstall a plugin
post
Update multiple plugins
post
Check whether a plugin version constraint is supported
post
Validate a plugin repository before installation
get
List failed plugins and errors
delete
Uninstall a failed plugin
post
Reload a failed plugin
post
Install a plugin from GitHub
post
Install a plugin with a shallow Git clone
post
Install a plugin from a downloadable ZIP URL
post
Install a plugin from an uploaded ZIP file
get
List plugin marketplace entries
get
List plugin marketplace categories
get
List plugin sources
put
Replace plugin sources
post
Add a plugin source
delete
Delete a plugin source
delete
Delete a plugin source by query ID
get
List plugin pages
get
Get plugin page entry HTML
get
Get a plugin page asset
get
Get the plugin page bridge SDK
get
Proxy a plugin extension GET route
put
Proxy a plugin extension PUT route
post
Proxy a plugin extension POST route
delete
Proxy a plugin extension DELETE route
patch
Proxy a plugin extension PATCH route
get
List MCP servers
post
Add an MCP server
put
Update an MCP server by body name
delete
Delete an MCP server by query name
patch
Enable or disable an MCP server by body name
post
Test an MCP server connection by body name
put
Update an MCP server
delete
Delete an MCP server
patch
Enable or disable an MCP server
post
Test an MCP server connection
post
Sync MCP servers from ModelScope
get
List skills
post
Upload or import a skill archive
post
Upload multiple skill archives
delete
Delete a skill by query name
patch
Update skill metadata or enabled state by body name
get
Download a skill archive by query name
get
List files in a skill by query name
get
Get skill file content by query name and path
put
Update skill file content by body name and path
delete
Delete a skill
patch
Update skill metadata or enabled state
get
Download a skill archive
get
List files in a skill
get
Get skill file content
put
Update skill file content
get
List Shipyard Neo skill candidates
get
List Shipyard Neo skill releases
get
Get a Shipyard Neo skill payload
post
Evaluate a Shipyard Neo skill candidate
post
Promote a Shipyard Neo skill candidate
post
Roll back a Shipyard Neo skill release
post
Sync a Shipyard Neo skill release
post
Delete a Shipyard Neo skill candidate
post
Delete a Shipyard Neo skill release
get
Get persona folder tree
get
List personas
post
Create a persona
get
Get a persona by query ID
put
Update a persona by body ID
delete
Delete a persona by query ID
get
Get a persona
put
Update a persona
delete
Delete a persona
get
List persona folders
post
Create a persona folder
put
Update a persona folder
delete
Delete a persona folder
post
Move a persona or folder
post
Reorder personas or folders
get
List active UMOs and session status
get
List active and known UMOs
get
List session rules
post
Update or create a session rule
post
Delete one or more session rules
patch
Batch update session provider selection
patch
Batch update session service settings
get
List session groups
post
Create a session group
put
Update a session group
delete
Delete a session group
get
List conversation history data
post
Delete multiple conversations
get
Get conversation details and messages
delete
Delete a conversation
patch
Update conversation metadata
put
Replace conversation message history
post
Export conversations
get
List text-to-image templates
post
Create a text-to-image template
get
Get active text-to-image template
put
Set active text-to-image template
post
Reset the default text-to-image template
get
Get a text-to-image template
put
Update a text-to-image template
delete
Delete a text-to-image template
get
Get subagent orchestrator configuration
put
Update subagent orchestrator configuration
get
List tools available to subagents