mirror of
https://github.com/AstrBotDevs/AstrBot
synced 2026-07-15 17:30:13 +08:00
5566bd621c
* feat: reorganize settings system configuration * fix: float system config restart notice * fix: blur system config restart notice * fix: tint restart notice blur background * fix: allow totp setup without body * fix: filter public openapi docs * fix: handle settings autosave cleanup * chore: ui
6345 lines
150 KiB
JSON
6345 lines
150 KiB
JSON
{
|
|
"openapi": "3.1.0",
|
|
"info": {
|
|
"title": "AstrBot OpenAPI v1",
|
|
"version": "0.1.0",
|
|
"description": "Target REST contract for migrating AstrBot HTTP APIs to /api/v1. Dynamic AstrBot configuration payloads are intentionally modeled as open JSON objects because their schemas are provided at runtime by template endpoints. Developer API keys currently support these scopes only: bot, provider, persona, im, config, chat, plugin, mcp, skill. The config scope also grants bot and provider access.\n"
|
|
},
|
|
"servers": [
|
|
{
|
|
"url": "http://localhost:6185",
|
|
"description": "Local AstrBot server"
|
|
}
|
|
],
|
|
"security": [
|
|
{
|
|
"ApiKeyAuth": []
|
|
}
|
|
],
|
|
"tags": [
|
|
{
|
|
"name": "System Config"
|
|
},
|
|
{
|
|
"name": "Config Profiles"
|
|
},
|
|
{
|
|
"name": "Bot Config Routes"
|
|
},
|
|
{
|
|
"name": "Bots"
|
|
},
|
|
{
|
|
"name": "Provider Sources"
|
|
},
|
|
{
|
|
"name": "Providers"
|
|
},
|
|
{
|
|
"name": "Chat"
|
|
},
|
|
{
|
|
"name": "IM"
|
|
},
|
|
{
|
|
"name": "Plugins"
|
|
},
|
|
{
|
|
"name": "Plugin Sources"
|
|
},
|
|
{
|
|
"name": "Plugin Pages"
|
|
},
|
|
{
|
|
"name": "MCP"
|
|
},
|
|
{
|
|
"name": "Skills"
|
|
},
|
|
{
|
|
"name": "Personas"
|
|
},
|
|
{
|
|
"name": "T2I"
|
|
},
|
|
{
|
|
"name": "Subagents"
|
|
}
|
|
],
|
|
"paths": {
|
|
"/api/v1/system-config/schema": {
|
|
"get": {
|
|
"tags": [
|
|
"System Config"
|
|
],
|
|
"summary": "Get the system configuration schema",
|
|
"operationId": "getSystemConfigSchema",
|
|
"x-astrbot-scope": "config",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/system-config": {
|
|
"get": {
|
|
"tags": [
|
|
"System Config"
|
|
],
|
|
"summary": "Get the system configuration",
|
|
"operationId": "getSystemConfig",
|
|
"x-astrbot-scope": "config",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"System Config"
|
|
],
|
|
"summary": "Replace the system configuration",
|
|
"operationId": "updateSystemConfig",
|
|
"x-astrbot-scope": "config",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/system-config/runtime": {
|
|
"get": {
|
|
"tags": [
|
|
"System Config"
|
|
],
|
|
"summary": "Get runtime-enriched system configuration metadata",
|
|
"operationId": "getSystemConfigRuntime",
|
|
"x-astrbot-scope": "config",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/config-profiles/schema": {
|
|
"get": {
|
|
"tags": [
|
|
"Config Profiles"
|
|
],
|
|
"summary": "Get the configuration profile schema",
|
|
"operationId": "getConfigProfileSchema",
|
|
"x-astrbot-scope": "config",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/config-profiles": {
|
|
"get": {
|
|
"tags": [
|
|
"Config Profiles"
|
|
],
|
|
"summary": "List configuration profiles",
|
|
"operationId": "listConfigProfiles",
|
|
"x-astrbot-scope": "config",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Config Profiles"
|
|
],
|
|
"summary": "Create a configuration profile",
|
|
"operationId": "createConfigProfile",
|
|
"x-astrbot-scope": "config",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/CreateConfigProfileRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/config-profiles/{config_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Config Profiles"
|
|
],
|
|
"summary": "Get a configuration profile",
|
|
"operationId": "getConfigProfile",
|
|
"x-astrbot-scope": "config",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/ConfigId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Config Profiles"
|
|
],
|
|
"summary": "Replace a configuration profile",
|
|
"operationId": "updateConfigProfileContent",
|
|
"x-astrbot-scope": "config",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/ConfigId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"tags": [
|
|
"Config Profiles"
|
|
],
|
|
"summary": "Rename a configuration profile",
|
|
"operationId": "renameConfigProfile",
|
|
"x-astrbot-scope": "config",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/ConfigId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/RenameRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Config Profiles"
|
|
],
|
|
"summary": "Delete a configuration profile",
|
|
"operationId": "deleteConfigProfile",
|
|
"x-astrbot-scope": "config",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/ConfigId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/config-routes": {
|
|
"get": {
|
|
"tags": [
|
|
"Bot Config Routes"
|
|
],
|
|
"summary": "List UMO to configuration profile bindings",
|
|
"operationId": "listConfigRoutes",
|
|
"x-astrbot-scope": "config",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Bot Config Routes"
|
|
],
|
|
"summary": "Replace all UMO to configuration profile bindings",
|
|
"operationId": "replaceConfigRoutes",
|
|
"x-astrbot-scope": "config",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ConfigRoutesReplaceRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/config-routes/{umo}": {
|
|
"put": {
|
|
"tags": [
|
|
"Bot Config Routes"
|
|
],
|
|
"summary": "Bind a UMO to a configuration profile",
|
|
"operationId": "upsertConfigRoute",
|
|
"x-astrbot-scope": "config",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Umo"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ConfigRouteUpsertRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Bot Config Routes"
|
|
],
|
|
"summary": "Remove a UMO configuration profile binding",
|
|
"operationId": "deleteConfigRoute",
|
|
"x-astrbot-scope": "config",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Umo"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/bot-types": {
|
|
"get": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "List configurable bot types and their schemas",
|
|
"operationId": "listBotTypes",
|
|
"x-astrbot-scope": "bot",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/bot-types/{bot_type}/registration": {
|
|
"post": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "Run a bot type registration flow action",
|
|
"operationId": "registerBotType",
|
|
"x-astrbot-scope": "bot",
|
|
"parameters": [
|
|
{
|
|
"name": "bot_type",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BotRegistrationRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/bots": {
|
|
"get": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "List created bots and their configurations",
|
|
"operationId": "listBots",
|
|
"x-astrbot-scope": "bot",
|
|
"parameters": [
|
|
{
|
|
"name": "enabled",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"name": "type",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "Create a bot from configuration",
|
|
"operationId": "createBot",
|
|
"x-astrbot-scope": "bot",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BotConfigRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/bots/stats": {
|
|
"get": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "List runtime status for all bots",
|
|
"operationId": "listBotStats",
|
|
"x-astrbot-scope": "bot",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/bots/by-id": {
|
|
"get": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "Get a bot configuration by query ID",
|
|
"operationId": "getBotById",
|
|
"x-astrbot-scope": "bot",
|
|
"parameters": [
|
|
{
|
|
"name": "bot_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "Replace a bot configuration by body ID",
|
|
"operationId": "updateBotById",
|
|
"x-astrbot-scope": "bot",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"bot_id",
|
|
"config"
|
|
],
|
|
"properties": {
|
|
"bot_id": {
|
|
"type": "string"
|
|
},
|
|
"config": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "Delete a bot by query ID",
|
|
"operationId": "deleteBotById",
|
|
"x-astrbot-scope": "bot",
|
|
"parameters": [
|
|
{
|
|
"name": "bot_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/bots/enabled": {
|
|
"patch": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "Enable or disable a bot by body ID",
|
|
"operationId": "setBotEnabledById",
|
|
"x-astrbot-scope": "bot",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"bot_id",
|
|
"enabled"
|
|
],
|
|
"properties": {
|
|
"bot_id": {
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/bots/test": {
|
|
"post": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "Test a bot registration or connection by body ID",
|
|
"operationId": "testBotById",
|
|
"x-astrbot-scope": "bot",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"bot_id"
|
|
],
|
|
"properties": {
|
|
"bot_id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/bots/{bot_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "Get a bot configuration",
|
|
"operationId": "getBot",
|
|
"x-astrbot-scope": "bot",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/BotId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "Replace a bot configuration",
|
|
"operationId": "updateBot",
|
|
"x-astrbot-scope": "bot",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/BotId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/BotConfigRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "Delete a bot",
|
|
"operationId": "deleteBot",
|
|
"x-astrbot-scope": "bot",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/BotId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/bots/{bot_id}/enabled": {
|
|
"patch": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "Enable or disable a bot",
|
|
"operationId": "setBotEnabled",
|
|
"x-astrbot-scope": "bot",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/BotId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/EnabledPatch"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/bots/{bot_id}/test": {
|
|
"post": {
|
|
"tags": [
|
|
"Bots"
|
|
],
|
|
"summary": "Test a bot registration or connection",
|
|
"operationId": "testBot",
|
|
"x-astrbot-scope": "bot",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/BotId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/providers/schema": {
|
|
"get": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Get the overall provider configuration schema",
|
|
"operationId": "getProviderSchema",
|
|
"x-astrbot-scope": "provider",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/provider-sources": {
|
|
"get": {
|
|
"tags": [
|
|
"Provider Sources"
|
|
],
|
|
"summary": "List provider sources",
|
|
"operationId": "listProviderSources",
|
|
"x-astrbot-scope": "provider",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Provider Sources"
|
|
],
|
|
"summary": "Create a provider source",
|
|
"operationId": "createProviderSource",
|
|
"x-astrbot-scope": "provider",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProviderSourceConfigRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/provider-sources/by-id": {
|
|
"get": {
|
|
"tags": [
|
|
"Provider Sources"
|
|
],
|
|
"summary": "Get a provider source by query ID",
|
|
"operationId": "getProviderSourceById",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"name": "source_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Provider Sources"
|
|
],
|
|
"summary": "Update a provider source by body ID",
|
|
"operationId": "upsertProviderSourceById",
|
|
"x-astrbot-scope": "provider",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"source_id",
|
|
"config"
|
|
],
|
|
"properties": {
|
|
"source_id": {
|
|
"type": "string"
|
|
},
|
|
"config": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Provider Sources"
|
|
],
|
|
"summary": "Delete a provider source by query ID",
|
|
"operationId": "deleteProviderSourceById",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"name": "source_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/provider-sources/models": {
|
|
"get": {
|
|
"tags": [
|
|
"Provider Sources"
|
|
],
|
|
"summary": "List models available from a provider source by query ID",
|
|
"operationId": "listProviderSourceModelsById",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"name": "source_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "capability",
|
|
"in": "query",
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProviderCapability"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/provider-sources/providers": {
|
|
"get": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "List providers under a provider source by query ID",
|
|
"operationId": "listProvidersBySourceId",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"name": "source_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "capability",
|
|
"in": "query",
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProviderCapability"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Create a provider under a provider source by body ID",
|
|
"operationId": "createProviderInSourceById",
|
|
"x-astrbot-scope": "provider",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"source_id",
|
|
"config"
|
|
],
|
|
"properties": {
|
|
"source_id": {
|
|
"type": "string"
|
|
},
|
|
"config": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/provider-sources/{source_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Provider Sources"
|
|
],
|
|
"summary": "Get a provider source",
|
|
"operationId": "getProviderSource",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SourceId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Provider Sources"
|
|
],
|
|
"summary": "Update a provider source or create it if missing",
|
|
"operationId": "upsertProviderSource",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SourceId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProviderSourceConfigRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Provider Sources"
|
|
],
|
|
"summary": "Delete a provider source and providers that reference it",
|
|
"operationId": "deleteProviderSource",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SourceId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/provider-sources/{source_id}/models": {
|
|
"get": {
|
|
"tags": [
|
|
"Provider Sources"
|
|
],
|
|
"summary": "List models available from a provider source",
|
|
"operationId": "listProviderSourceModels",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SourceId"
|
|
},
|
|
{
|
|
"name": "capability",
|
|
"in": "query",
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProviderCapability"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/provider-sources/{source_id}/providers": {
|
|
"get": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "List providers under a provider source",
|
|
"operationId": "listProvidersBySource",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SourceId"
|
|
},
|
|
{
|
|
"name": "capability",
|
|
"in": "query",
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProviderCapability"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Create a provider under a provider source",
|
|
"operationId": "createProviderInSource",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SourceId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProviderConfigRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/providers": {
|
|
"get": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "List providers by capability or source",
|
|
"operationId": "listProviders",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"name": "capability",
|
|
"in": "query",
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProviderCapability"
|
|
}
|
|
},
|
|
{
|
|
"name": "source_id",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "enabled",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Create a standalone provider",
|
|
"operationId": "createProvider",
|
|
"x-astrbot-scope": "provider",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProviderConfigRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/providers/by-id": {
|
|
"get": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Get a provider configuration by query ID",
|
|
"operationId": "getProviderById",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"name": "provider_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "merged",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Replace a provider configuration by body ID",
|
|
"operationId": "updateProviderById",
|
|
"x-astrbot-scope": "provider",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"provider_id",
|
|
"config"
|
|
],
|
|
"properties": {
|
|
"provider_id": {
|
|
"type": "string"
|
|
},
|
|
"config": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Delete a provider by query ID",
|
|
"operationId": "deleteProviderById",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"name": "provider_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/providers/enabled": {
|
|
"patch": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Enable or disable a provider by body ID",
|
|
"operationId": "setProviderEnabledById",
|
|
"x-astrbot-scope": "provider",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"provider_id",
|
|
"enabled"
|
|
],
|
|
"properties": {
|
|
"provider_id": {
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/providers/test": {
|
|
"post": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Test a provider by body ID",
|
|
"operationId": "testProviderById",
|
|
"x-astrbot-scope": "provider",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"provider_id"
|
|
],
|
|
"properties": {
|
|
"provider_id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/providers/embedding-dimension": {
|
|
"post": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Probe embedding dimension for a provider by body ID",
|
|
"operationId": "getProviderEmbeddingDimensionById",
|
|
"x-astrbot-scope": "provider",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"provider_id"
|
|
],
|
|
"properties": {
|
|
"provider_id": {
|
|
"type": "string"
|
|
},
|
|
"provider_config": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/providers/{provider_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Get a provider configuration",
|
|
"operationId": "getProvider",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/ProviderId"
|
|
},
|
|
{
|
|
"name": "merged",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Replace a provider configuration",
|
|
"operationId": "updateProvider",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/ProviderId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ProviderConfigRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Delete a provider",
|
|
"operationId": "deleteProvider",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/ProviderId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": false,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/providers/{provider_id}/enabled": {
|
|
"patch": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Enable or disable a provider",
|
|
"operationId": "setProviderEnabled",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/ProviderId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/EnabledPatch"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/providers/{provider_id}/test": {
|
|
"post": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Test a provider",
|
|
"operationId": "testProvider",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/ProviderId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/providers/{provider_id}/embedding-dimension": {
|
|
"post": {
|
|
"tags": [
|
|
"Providers"
|
|
],
|
|
"summary": "Probe embedding dimension for a provider",
|
|
"operationId": "getProviderEmbeddingDimension",
|
|
"x-astrbot-scope": "provider",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/ProviderId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": false,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat": {
|
|
"post": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Send a webchat message",
|
|
"operationId": "sendChatMessage",
|
|
"x-astrbot-scope": "chat",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ChatRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/ws": {
|
|
"get": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Open a streaming chat WebSocket",
|
|
"operationId": "openChatWebSocket",
|
|
"x-websocket": true,
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"name": "api_key",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "key",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"101": {
|
|
"description": "WebSocket upgrade accepted"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/sessions": {
|
|
"get": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "List webchat sessions",
|
|
"operationId": "listChatSessions",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Page"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/PageSize"
|
|
},
|
|
{
|
|
"name": "username",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/sessions/new": {
|
|
"get": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Create a webchat session",
|
|
"operationId": "createChatSession",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"name": "platform_id",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"default": "webchat"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/sessions/batch-delete": {
|
|
"post": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Delete multiple webchat sessions",
|
|
"operationId": "batchDeleteChatSessions",
|
|
"x-astrbot-scope": "chat",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ChatSessionBatchDeleteRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/sessions/{session_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Get a webchat session and its messages",
|
|
"operationId": "getChatSession",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SessionId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Update a webchat session",
|
|
"operationId": "updateChatSession",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SessionId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ChatSessionPatchRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Delete a webchat session",
|
|
"operationId": "deleteChatSession",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SessionId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/sessions/{session_id}/stop": {
|
|
"post": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Stop active webchat work for a session",
|
|
"operationId": "stopChatSession",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SessionId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/sessions/{session_id}/messages/{message_id}": {
|
|
"patch": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Update the latest user message in a webchat session",
|
|
"operationId": "updateChatMessage",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SessionId"
|
|
},
|
|
{
|
|
"name": "message_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ChatMessagePatchRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/sessions/{session_id}/messages/{message_id}/regenerate": {
|
|
"post": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Regenerate a bot message in a webchat session",
|
|
"operationId": "regenerateChatMessage",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SessionId"
|
|
},
|
|
{
|
|
"name": "message_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": false,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ChatMessageRegenerateRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Server-sent chat stream or an error envelope"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/configs": {
|
|
"get": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "List chat-selectable configuration profiles",
|
|
"operationId": "listChatConfigs",
|
|
"x-astrbot-scope": "config",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/threads": {
|
|
"post": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Create or reuse a side thread from a webchat message",
|
|
"operationId": "createChatThread",
|
|
"x-astrbot-scope": "chat",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ChatThreadCreateRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/threads/{thread_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Get a webchat side thread",
|
|
"operationId": "getChatThread",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"name": "thread_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Delete a webchat side thread",
|
|
"operationId": "deleteChatThread",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"name": "thread_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/threads/{thread_id}/messages": {
|
|
"post": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Send a message inside a webchat side thread",
|
|
"operationId": "sendChatThreadMessage",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"name": "thread_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ChatThreadMessageRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"description": "Server-sent chat stream or an error envelope"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/projects": {
|
|
"get": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "List ChatUI projects",
|
|
"operationId": "listChatProjects",
|
|
"x-astrbot-scope": "chat",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Create a ChatUI project",
|
|
"operationId": "createChatProject",
|
|
"x-astrbot-scope": "chat",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ChatProjectRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/projects/{project_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Get a ChatUI project",
|
|
"operationId": "getChatProject",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"name": "project_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Update a ChatUI project",
|
|
"operationId": "updateChatProject",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"name": "project_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ChatProjectRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Delete a ChatUI project",
|
|
"operationId": "deleteChatProject",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"name": "project_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/projects/{project_id}/sessions": {
|
|
"get": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "List sessions in a ChatUI project",
|
|
"operationId": "listChatProjectSessions",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"name": "project_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/projects/{project_id}/sessions/{session_id}": {
|
|
"post": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Add a session to a ChatUI project",
|
|
"operationId": "addChatProjectSession",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"name": "project_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/SessionId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/chat/projects/sessions/{session_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"Chat"
|
|
],
|
|
"summary": "Remove a session from its ChatUI project",
|
|
"operationId": "removeChatProjectSession",
|
|
"x-astrbot-scope": "chat",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SessionId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/im/messages": {
|
|
"post": {
|
|
"tags": [
|
|
"IM"
|
|
],
|
|
"summary": "Send a message to a UMO",
|
|
"operationId": "sendImMessage",
|
|
"x-astrbot-scope": "im",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ImMessageRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/im/bots": {
|
|
"get": {
|
|
"tags": [
|
|
"IM"
|
|
],
|
|
"summary": "List active IM bot IDs",
|
|
"operationId": "listImBots",
|
|
"x-astrbot-scope": "im",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "List installed plugins",
|
|
"operationId": "listPlugins",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "include_reserved",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean",
|
|
"default": true
|
|
}
|
|
},
|
|
{
|
|
"name": "enabled",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/by-id": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Get plugin details by query ID",
|
|
"operationId": "getPluginById",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Uninstall a plugin by query ID",
|
|
"operationId": "uninstallPluginById",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": false,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"delete_config": {
|
|
"type": "boolean"
|
|
},
|
|
"delete_data": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/config": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Get plugin configuration by query ID",
|
|
"operationId": "getPluginConfigById",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Save plugin configuration by body ID",
|
|
"operationId": "updatePluginConfigById",
|
|
"x-astrbot-scope": "plugin",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"plugin_id",
|
|
"config"
|
|
],
|
|
"properties": {
|
|
"plugin_id": {
|
|
"type": "string"
|
|
},
|
|
"config": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/config/schema": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Get plugin configuration schema by query ID",
|
|
"operationId": "getPluginConfigSchemaById",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/config-files": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "List uploaded files for a plugin file configuration item by query ID",
|
|
"operationId": "listPluginConfigFilesById",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "config_key",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Upload files for a plugin file configuration item by query ID",
|
|
"operationId": "uploadPluginConfigFilesById",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "config_key",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Delete a plugin file configuration upload by query ID",
|
|
"operationId": "deletePluginConfigFileById",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PluginConfigFileDeleteRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/readme": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Get plugin README content by query ID",
|
|
"operationId": "getPluginReadmeById",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Text"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/changelog": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Get plugin CHANGELOG content by query ID",
|
|
"operationId": "getPluginChangelogById",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Text"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/reload": {
|
|
"post": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Reload a plugin by body ID",
|
|
"operationId": "reloadPluginById",
|
|
"x-astrbot-scope": "plugin",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"plugin_id"
|
|
],
|
|
"properties": {
|
|
"plugin_id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/enabled": {
|
|
"patch": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Enable or disable a plugin by body ID",
|
|
"operationId": "setPluginEnabledById",
|
|
"x-astrbot-scope": "plugin",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"plugin_id",
|
|
"enabled"
|
|
],
|
|
"properties": {
|
|
"plugin_id": {
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/pages": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugin Pages"
|
|
],
|
|
"summary": "List plugin pages by query ID",
|
|
"operationId": "listPluginPagesById",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/page": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugin Pages"
|
|
],
|
|
"summary": "Get plugin page entry HTML by query ID",
|
|
"operationId": "getPluginPageById",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "page_name",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Html"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/page/assets": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugin Pages"
|
|
],
|
|
"summary": "Get a plugin page asset by query ID",
|
|
"operationId": "getPluginPageAssetById",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "page_name",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "asset_path",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Plugin asset content"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/{plugin_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Get plugin details",
|
|
"operationId": "getPlugin",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": false,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"delete_config": {
|
|
"type": "boolean"
|
|
},
|
|
"delete_data": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Uninstall a plugin",
|
|
"operationId": "uninstallPlugin",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": false,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"delete_config": {
|
|
"type": "boolean"
|
|
},
|
|
"delete_data": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/{plugin_id}/config": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Get plugin configuration",
|
|
"operationId": "getPluginConfig",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Save plugin configuration",
|
|
"operationId": "updatePluginConfig",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/{plugin_id}/config/schema": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Get plugin configuration schema",
|
|
"operationId": "getPluginConfigSchema",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/{plugin_id}/config-files/{config_key}": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "List uploaded files for a plugin file configuration item",
|
|
"operationId": "listPluginConfigFiles",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
},
|
|
{
|
|
"name": "config_key",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "URL-encoded configuration key path.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Upload files for a plugin file configuration item",
|
|
"operationId": "uploadPluginConfigFiles",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
},
|
|
{
|
|
"name": "config_key",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "URL-encoded configuration key path.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/{plugin_id}/config-files": {
|
|
"delete": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Delete a plugin file configuration upload",
|
|
"operationId": "deletePluginConfigFile",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PluginConfigFileDeleteRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/{plugin_id}/readme": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Get plugin README content",
|
|
"operationId": "getPluginReadme",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Text"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/{plugin_id}/changelog": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Get plugin CHANGELOG content",
|
|
"operationId": "getPluginChangelog",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Text"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/{plugin_id}/reload": {
|
|
"post": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Reload a plugin",
|
|
"operationId": "reloadPlugin",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/{plugin_id}/enabled": {
|
|
"patch": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Enable or disable a plugin",
|
|
"operationId": "setPluginEnabled",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/EnabledPatch"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/{plugin_id}/update": {
|
|
"post": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Update or reinstall a plugin",
|
|
"operationId": "updatePlugin",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": false,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PluginUpdateRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/update": {
|
|
"post": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Update multiple plugins",
|
|
"operationId": "updatePlugins",
|
|
"x-astrbot-scope": "plugin",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PluginBatchUpdateRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/version-support/check": {
|
|
"post": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Check whether a plugin version constraint is supported",
|
|
"operationId": "checkPluginVersionSupport",
|
|
"x-astrbot-scope": "plugin",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PluginVersionSupportRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/failed": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "List failed plugins and errors",
|
|
"operationId": "listFailedPlugins",
|
|
"x-astrbot-scope": "plugin",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/failed/{plugin_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Uninstall a failed plugin",
|
|
"operationId": "uninstallFailedPlugin",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": false,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"delete_config": {
|
|
"type": "boolean"
|
|
},
|
|
"delete_data": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/failed/{plugin_id}/reload": {
|
|
"post": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Reload a failed plugin",
|
|
"operationId": "reloadFailedPlugin",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/install/github": {
|
|
"post": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Install a plugin from GitHub",
|
|
"operationId": "installPluginFromGithub",
|
|
"x-astrbot-scope": "plugin",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PluginGithubInstallRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/install/url": {
|
|
"post": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Install a plugin from a downloadable ZIP URL",
|
|
"operationId": "installPluginFromUrl",
|
|
"x-astrbot-scope": "plugin",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PluginUrlInstallRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/install/upload": {
|
|
"post": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "Install a plugin from an uploaded ZIP file",
|
|
"operationId": "installPluginFromUpload",
|
|
"x-astrbot-scope": "plugin",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PluginUploadInstallRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/market": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "List plugin marketplace entries",
|
|
"operationId": "listPluginMarket",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Page"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/PageSize"
|
|
},
|
|
{
|
|
"name": "category",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "sort",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string",
|
|
"enum": [
|
|
"recommended",
|
|
"downloads",
|
|
"updated",
|
|
"name"
|
|
]
|
|
}
|
|
},
|
|
{
|
|
"name": "keyword",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "force_refresh",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"name": "custom_registry",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/market/categories": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugins"
|
|
],
|
|
"summary": "List plugin marketplace categories",
|
|
"operationId": "listPluginMarketCategories",
|
|
"x-astrbot-scope": "plugin",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugin-sources": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugin Sources"
|
|
],
|
|
"summary": "List plugin sources",
|
|
"operationId": "listPluginSources",
|
|
"x-astrbot-scope": "plugin",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Plugin Sources"
|
|
],
|
|
"summary": "Add a plugin source",
|
|
"operationId": "createPluginSource",
|
|
"x-astrbot-scope": "plugin",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PluginSourceRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Plugin Sources"
|
|
],
|
|
"summary": "Replace plugin sources",
|
|
"operationId": "replacePluginSources",
|
|
"x-astrbot-scope": "plugin",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"sources"
|
|
],
|
|
"properties": {
|
|
"sources": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/PluginSourceRequest"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugin-sources/{source_id}": {
|
|
"delete": {
|
|
"tags": [
|
|
"Plugin Sources"
|
|
],
|
|
"summary": "Delete a plugin source",
|
|
"operationId": "deletePluginSource",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SourceId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugin-sources/by-id": {
|
|
"delete": {
|
|
"tags": [
|
|
"Plugin Sources"
|
|
],
|
|
"summary": "Delete a plugin source by query ID",
|
|
"operationId": "deletePluginSourceById",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "source_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/{plugin_id}/pages": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugin Pages"
|
|
],
|
|
"summary": "List plugin pages",
|
|
"operationId": "listPluginPages",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/{plugin_id}/pages/{page_name}": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugin Pages"
|
|
],
|
|
"summary": "Get plugin page entry HTML",
|
|
"operationId": "getPluginPage",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
},
|
|
{
|
|
"name": "page_name",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Html"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/{plugin_id}/pages/{page_name}/assets/{asset_path}": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugin Pages"
|
|
],
|
|
"summary": "Get a plugin page asset",
|
|
"operationId": "getPluginPageAsset",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PluginId"
|
|
},
|
|
{
|
|
"name": "page_name",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "asset_path",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "URL-encoded relative asset path.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Plugin asset content"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/page-bridge-sdk.js": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugin Pages"
|
|
],
|
|
"summary": "Get the plugin page bridge SDK",
|
|
"operationId": "getPluginPageBridgeSdk",
|
|
"x-astrbot-scope": "plugin",
|
|
"responses": {
|
|
"200": {
|
|
"description": "JavaScript bridge SDK",
|
|
"content": {
|
|
"application/javascript": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/plugins/extensions/{plugin_path}": {
|
|
"get": {
|
|
"tags": [
|
|
"Plugin Pages"
|
|
],
|
|
"summary": "Proxy a plugin extension GET route",
|
|
"operationId": "getPluginExtensionRoute",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_path",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Plugin extension path after /api/plug/. It may contain slash-separated segments.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Plugin Pages"
|
|
],
|
|
"summary": "Proxy a plugin extension POST route",
|
|
"operationId": "postPluginExtensionRoute",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_path",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "Plugin extension path after /api/plug/. It may contain slash-separated segments.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": false,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
},
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"type": "object",
|
|
"additionalProperties": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Plugin Pages"
|
|
],
|
|
"summary": "Proxy a plugin extension PUT route",
|
|
"operationId": "putPluginExtensionRoute",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": false,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"tags": [
|
|
"Plugin Pages"
|
|
],
|
|
"summary": "Proxy a plugin extension PATCH route",
|
|
"operationId": "patchPluginExtensionRoute",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": false,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Plugin Pages"
|
|
],
|
|
"summary": "Proxy a plugin extension DELETE route",
|
|
"operationId": "deletePluginExtensionRoute",
|
|
"x-astrbot-scope": "plugin",
|
|
"parameters": [
|
|
{
|
|
"name": "plugin_path",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/mcp/servers": {
|
|
"get": {
|
|
"tags": [
|
|
"MCP"
|
|
],
|
|
"summary": "List MCP servers",
|
|
"operationId": "listMcpServers",
|
|
"x-astrbot-scope": "mcp",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"MCP"
|
|
],
|
|
"summary": "Add an MCP server",
|
|
"operationId": "createMcpServer",
|
|
"x-astrbot-scope": "mcp",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/McpServerConfig"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/mcp/servers/by-name": {
|
|
"put": {
|
|
"tags": [
|
|
"MCP"
|
|
],
|
|
"summary": "Update an MCP server by body name",
|
|
"operationId": "updateMcpServerByName",
|
|
"x-astrbot-scope": "mcp",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"server_name"
|
|
],
|
|
"properties": {
|
|
"server_name": {
|
|
"type": "string"
|
|
},
|
|
"config": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"MCP"
|
|
],
|
|
"summary": "Delete an MCP server by query name",
|
|
"operationId": "deleteMcpServerByName",
|
|
"x-astrbot-scope": "mcp",
|
|
"parameters": [
|
|
{
|
|
"name": "server_name",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/mcp/servers/enabled": {
|
|
"patch": {
|
|
"tags": [
|
|
"MCP"
|
|
],
|
|
"summary": "Enable or disable an MCP server by body name",
|
|
"operationId": "setMcpServerEnabledByName",
|
|
"x-astrbot-scope": "mcp",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"server_name",
|
|
"enabled"
|
|
],
|
|
"properties": {
|
|
"server_name": {
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/mcp/servers/test": {
|
|
"post": {
|
|
"tags": [
|
|
"MCP"
|
|
],
|
|
"summary": "Test an MCP server connection by body name",
|
|
"operationId": "testMcpServerByName",
|
|
"x-astrbot-scope": "mcp",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"server_name"
|
|
],
|
|
"properties": {
|
|
"server_name": {
|
|
"type": "string"
|
|
},
|
|
"mcp_server_config": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
},
|
|
"config": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/mcp/servers/{server_name}": {
|
|
"put": {
|
|
"tags": [
|
|
"MCP"
|
|
],
|
|
"summary": "Update an MCP server",
|
|
"operationId": "updateMcpServer",
|
|
"x-astrbot-scope": "mcp",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/ServerName"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/McpServerConfig"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"MCP"
|
|
],
|
|
"summary": "Delete an MCP server",
|
|
"operationId": "deleteMcpServer",
|
|
"x-astrbot-scope": "mcp",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/ServerName"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/mcp/servers/{server_name}/enabled": {
|
|
"patch": {
|
|
"tags": [
|
|
"MCP"
|
|
],
|
|
"summary": "Enable or disable an MCP server",
|
|
"operationId": "setMcpServerEnabled",
|
|
"x-astrbot-scope": "mcp",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/ServerName"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/EnabledPatch"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/mcp/servers/{server_name}/test": {
|
|
"post": {
|
|
"tags": [
|
|
"MCP"
|
|
],
|
|
"summary": "Test an MCP server connection",
|
|
"operationId": "testMcpServer",
|
|
"x-astrbot-scope": "mcp",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/ServerName"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": false,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"mcp_server_config": {
|
|
"type": "object",
|
|
"additionalProperties": true
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/mcp/providers/modelscope/sync": {
|
|
"post": {
|
|
"tags": [
|
|
"MCP"
|
|
],
|
|
"summary": "Sync MCP servers from ModelScope",
|
|
"operationId": "syncModelScopeMcpServers",
|
|
"x-astrbot-scope": "mcp",
|
|
"requestBody": {
|
|
"required": false,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ModelScopeSyncRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills": {
|
|
"get": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "List skills",
|
|
"operationId": "listSkills",
|
|
"x-astrbot-scope": "skill",
|
|
"parameters": [
|
|
{
|
|
"name": "enabled",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
{
|
|
"name": "source",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Upload or import a skill archive",
|
|
"operationId": "uploadSkill",
|
|
"x-astrbot-scope": "skill",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/SkillUploadRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/batch": {
|
|
"post": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Upload multiple skill archives",
|
|
"operationId": "uploadSkillsBatch",
|
|
"x-astrbot-scope": "skill",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"multipart/form-data": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"files"
|
|
],
|
|
"properties": {
|
|
"files": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/by-name": {
|
|
"patch": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Update skill metadata or enabled state by body name",
|
|
"operationId": "updateSkillByName",
|
|
"x-astrbot-scope": "skill",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"skill_name"
|
|
],
|
|
"properties": {
|
|
"skill_name": {
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"active": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Delete a skill by query name",
|
|
"operationId": "deleteSkillByName",
|
|
"x-astrbot-scope": "skill",
|
|
"parameters": [
|
|
{
|
|
"name": "skill_name",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/archive": {
|
|
"get": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Download a skill archive by query name",
|
|
"operationId": "downloadSkillByName",
|
|
"x-astrbot-scope": "skill",
|
|
"parameters": [
|
|
{
|
|
"name": "skill_name",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Skill archive",
|
|
"content": {
|
|
"application/zip": {
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/files": {
|
|
"get": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "List files in a skill by query name",
|
|
"operationId": "listSkillFilesByName",
|
|
"x-astrbot-scope": "skill",
|
|
"parameters": [
|
|
{
|
|
"name": "skill_name",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "path",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/file": {
|
|
"get": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Get skill file content by query name and path",
|
|
"operationId": "getSkillFileByName",
|
|
"x-astrbot-scope": "skill",
|
|
"parameters": [
|
|
{
|
|
"name": "skill_name",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "path",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Text"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Update skill file content by body name and path",
|
|
"operationId": "updateSkillFileByName",
|
|
"x-astrbot-scope": "skill",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"skill_name",
|
|
"path",
|
|
"content"
|
|
],
|
|
"properties": {
|
|
"skill_name": {
|
|
"type": "string"
|
|
},
|
|
"path": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/{skill_name}": {
|
|
"patch": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Update skill metadata or enabled state",
|
|
"operationId": "updateSkill",
|
|
"x-astrbot-scope": "skill",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SkillName"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/SkillPatchRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Delete a skill",
|
|
"operationId": "deleteSkill",
|
|
"x-astrbot-scope": "skill",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SkillName"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/{skill_name}/archive": {
|
|
"get": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Download a skill archive",
|
|
"operationId": "downloadSkill",
|
|
"x-astrbot-scope": "skill",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SkillName"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Skill archive",
|
|
"content": {
|
|
"application/zip": {
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/{skill_name}/files": {
|
|
"get": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "List files in a skill",
|
|
"operationId": "listSkillFiles",
|
|
"x-astrbot-scope": "skill",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SkillName"
|
|
},
|
|
{
|
|
"name": "path",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/{skill_name}/files/{file_path}": {
|
|
"get": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Get skill file content",
|
|
"operationId": "getSkillFile",
|
|
"x-astrbot-scope": "skill",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SkillName"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/FilePath"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Text"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Update skill file content",
|
|
"operationId": "updateSkillFile",
|
|
"x-astrbot-scope": "skill",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/SkillName"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/FilePath"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"text/plain": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/neo/candidates": {
|
|
"get": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "List Shipyard Neo skill candidates",
|
|
"operationId": "listNeoSkillCandidates",
|
|
"x-astrbot-scope": "skill",
|
|
"parameters": [
|
|
{
|
|
"name": "skill_key",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "status",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/neo/releases": {
|
|
"get": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "List Shipyard Neo skill releases",
|
|
"operationId": "listNeoSkillReleases",
|
|
"x-astrbot-scope": "skill",
|
|
"parameters": [
|
|
{
|
|
"name": "skill_key",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"name": "stage",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/neo/payload": {
|
|
"get": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Get a Shipyard Neo skill payload",
|
|
"operationId": "getNeoSkillPayload",
|
|
"x-astrbot-scope": "skill",
|
|
"parameters": [
|
|
{
|
|
"name": "payload_ref",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/neo/evaluate": {
|
|
"post": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Evaluate a Shipyard Neo skill candidate",
|
|
"operationId": "evaluateNeoSkillCandidate",
|
|
"x-astrbot-scope": "skill",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NeoCandidateActionRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/neo/promote": {
|
|
"post": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Promote a Shipyard Neo skill candidate",
|
|
"operationId": "promoteNeoSkillCandidate",
|
|
"x-astrbot-scope": "skill",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NeoCandidateActionRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/neo/rollback": {
|
|
"post": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Roll back a Shipyard Neo skill release",
|
|
"operationId": "rollbackNeoSkillRelease",
|
|
"x-astrbot-scope": "skill",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NeoReleaseActionRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/neo/sync": {
|
|
"post": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Sync a Shipyard Neo skill release",
|
|
"operationId": "syncNeoSkillRelease",
|
|
"x-astrbot-scope": "skill",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NeoReleaseActionRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/neo/candidates/delete": {
|
|
"post": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Delete a Shipyard Neo skill candidate",
|
|
"operationId": "deleteNeoSkillCandidate",
|
|
"x-astrbot-scope": "skill",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NeoCandidateActionRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/skills/neo/releases/delete": {
|
|
"post": {
|
|
"tags": [
|
|
"Skills"
|
|
],
|
|
"summary": "Delete a Shipyard Neo skill release",
|
|
"operationId": "deleteNeoSkillRelease",
|
|
"x-astrbot-scope": "skill",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NeoReleaseActionRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/personas/tree": {
|
|
"get": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "Get persona folder tree",
|
|
"operationId": "getPersonaTree",
|
|
"x-astrbot-scope": "persona",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/personas": {
|
|
"get": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "List personas",
|
|
"operationId": "listPersonas",
|
|
"x-astrbot-scope": "persona",
|
|
"parameters": [
|
|
{
|
|
"name": "folder_id",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "Create a persona",
|
|
"operationId": "createPersona",
|
|
"x-astrbot-scope": "persona",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PersonaRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/personas/by-id": {
|
|
"get": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "Get a persona by query ID",
|
|
"operationId": "getPersonaById",
|
|
"x-astrbot-scope": "persona",
|
|
"parameters": [
|
|
{
|
|
"name": "persona_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "Update a persona by body ID",
|
|
"operationId": "updatePersonaById",
|
|
"x-astrbot-scope": "persona",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"required": [
|
|
"persona_id"
|
|
],
|
|
"properties": {
|
|
"persona_id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "Delete a persona by query ID",
|
|
"operationId": "deletePersonaById",
|
|
"x-astrbot-scope": "persona",
|
|
"parameters": [
|
|
{
|
|
"name": "persona_id",
|
|
"in": "query",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/personas/{persona_id}": {
|
|
"get": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "Get a persona",
|
|
"operationId": "getPersona",
|
|
"x-astrbot-scope": "persona",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PersonaId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "Update a persona",
|
|
"operationId": "updatePersona",
|
|
"x-astrbot-scope": "persona",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PersonaId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PersonaRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "Delete a persona",
|
|
"operationId": "deletePersona",
|
|
"x-astrbot-scope": "persona",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/PersonaId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/persona-folders": {
|
|
"get": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "List persona folders",
|
|
"operationId": "listPersonaFolders",
|
|
"x-astrbot-scope": "persona",
|
|
"parameters": [
|
|
{
|
|
"name": "parent_id",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "Create a persona folder",
|
|
"operationId": "createPersonaFolder",
|
|
"x-astrbot-scope": "persona",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PersonaFolderRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/persona-folders/{folder_id}": {
|
|
"put": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "Update a persona folder",
|
|
"operationId": "updatePersonaFolder",
|
|
"x-astrbot-scope": "persona",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/FolderId"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PersonaFolderRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "Delete a persona folder",
|
|
"operationId": "deletePersonaFolder",
|
|
"x-astrbot-scope": "persona",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/FolderId"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/personas/move": {
|
|
"post": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "Move a persona or folder",
|
|
"operationId": "movePersonaItem",
|
|
"x-astrbot-scope": "persona",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/PersonaMoveRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/personas/reorder": {
|
|
"post": {
|
|
"tags": [
|
|
"Personas"
|
|
],
|
|
"summary": "Reorder personas or folders",
|
|
"operationId": "reorderPersonaItems",
|
|
"x-astrbot-scope": "persona",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/ReorderRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/t2i/templates": {
|
|
"get": {
|
|
"tags": [
|
|
"T2I"
|
|
],
|
|
"summary": "List text-to-image templates",
|
|
"operationId": "listT2iTemplates",
|
|
"x-astrbot-scope": "config",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"tags": [
|
|
"T2I"
|
|
],
|
|
"summary": "Create a text-to-image template",
|
|
"operationId": "createT2iTemplate",
|
|
"x-astrbot-scope": "config",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/T2iTemplateRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/t2i/templates/active": {
|
|
"get": {
|
|
"tags": [
|
|
"T2I"
|
|
],
|
|
"summary": "Get active text-to-image template",
|
|
"operationId": "getActiveT2iTemplate",
|
|
"x-astrbot-scope": "config",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"T2I"
|
|
],
|
|
"summary": "Set active text-to-image template",
|
|
"operationId": "setActiveT2iTemplate",
|
|
"x-astrbot-scope": "config",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/NameRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/t2i/templates/default/reset": {
|
|
"post": {
|
|
"tags": [
|
|
"T2I"
|
|
],
|
|
"summary": "Reset the default text-to-image template",
|
|
"operationId": "resetDefaultT2iTemplate",
|
|
"x-astrbot-scope": "config",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/t2i/templates/{name}": {
|
|
"get": {
|
|
"tags": [
|
|
"T2I"
|
|
],
|
|
"summary": "Get a text-to-image template",
|
|
"operationId": "getT2iTemplate",
|
|
"x-astrbot-scope": "config",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Name"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"T2I"
|
|
],
|
|
"summary": "Update a text-to-image template",
|
|
"operationId": "updateT2iTemplate",
|
|
"x-astrbot-scope": "config",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Name"
|
|
}
|
|
],
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/T2iTemplateContentRequest"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"tags": [
|
|
"T2I"
|
|
],
|
|
"summary": "Delete a text-to-image template",
|
|
"operationId": "deleteT2iTemplate",
|
|
"x-astrbot-scope": "config",
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/Name"
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/subagents/config": {
|
|
"get": {
|
|
"tags": [
|
|
"Subagents"
|
|
],
|
|
"summary": "Get subagent orchestrator configuration",
|
|
"operationId": "getSubagentConfig",
|
|
"x-astrbot-scope": "config",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
},
|
|
"put": {
|
|
"tags": [
|
|
"Subagents"
|
|
],
|
|
"summary": "Update subagent orchestrator configuration",
|
|
"operationId": "updateSubagentConfig",
|
|
"x-astrbot-scope": "config",
|
|
"requestBody": {
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/api/v1/subagents/available-tools": {
|
|
"get": {
|
|
"tags": [
|
|
"Subagents"
|
|
],
|
|
"summary": "List tools available to subagents",
|
|
"operationId": "listSubagentAvailableTools",
|
|
"x-astrbot-scope": "config",
|
|
"responses": {
|
|
"200": {
|
|
"$ref": "#/components/responses/Ok"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"securitySchemes": {
|
|
"ApiKeyAuth": {
|
|
"type": "apiKey",
|
|
"in": "header",
|
|
"name": "X-API-Key"
|
|
},
|
|
"BearerAuth": {
|
|
"type": "http",
|
|
"scheme": "bearer",
|
|
"bearerFormat": "JWT"
|
|
}
|
|
},
|
|
"responses": {
|
|
"Ok": {
|
|
"description": "Standard AstrBot success response",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/SuccessEnvelope"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Text": {
|
|
"description": "Text response",
|
|
"content": {
|
|
"text/plain": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/SuccessEnvelope"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"Html": {
|
|
"description": "HTML response",
|
|
"content": {
|
|
"text/html": {
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": {
|
|
"BotId": {
|
|
"name": "bot_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"ConfigId": {
|
|
"name": "config_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"FilePath": {
|
|
"name": "file_path",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "URL-encoded relative file path.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"FolderId": {
|
|
"name": "folder_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"Name": {
|
|
"name": "name",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"Page": {
|
|
"name": "page",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"default": 1
|
|
}
|
|
},
|
|
"PageSize": {
|
|
"name": "page_size",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 1,
|
|
"maximum": 200,
|
|
"default": 20
|
|
}
|
|
},
|
|
"PersonaId": {
|
|
"name": "persona_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"PluginId": {
|
|
"name": "plugin_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"ProviderId": {
|
|
"name": "provider_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"SessionId": {
|
|
"name": "session_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"ServerName": {
|
|
"name": "server_name",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"SkillName": {
|
|
"name": "skill_name",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"SourceId": {
|
|
"name": "source_id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"Umo": {
|
|
"name": "umo",
|
|
"in": "path",
|
|
"required": true,
|
|
"description": "URL-encoded unified message origin.",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"schemas": {
|
|
"SuccessEnvelope": {
|
|
"type": "object",
|
|
"required": [
|
|
"status",
|
|
"data"
|
|
],
|
|
"properties": {
|
|
"status": {
|
|
"type": "string",
|
|
"const": "ok"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"data": {}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"DynamicConfig": {
|
|
"type": "object",
|
|
"additionalProperties": true
|
|
},
|
|
"ProviderCapability": {
|
|
"type": "string",
|
|
"enum": [
|
|
"chat",
|
|
"agent",
|
|
"stt",
|
|
"tts",
|
|
"embedding",
|
|
"rerank"
|
|
]
|
|
},
|
|
"CreateConfigProfileRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"config": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"RenameRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"NameRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ConfigRoutesReplaceRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"routing"
|
|
],
|
|
"properties": {
|
|
"routing": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ConfigRouteUpsertRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"config_id"
|
|
],
|
|
"properties": {
|
|
"config_id": {
|
|
"type": "string",
|
|
"description": "Use \"default\" to remove a custom route and fall back."
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"BotConfigRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"type",
|
|
"config"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "Platform adapter type, such as aiocqhttp, telegram, lark."
|
|
},
|
|
"enabled": {
|
|
"type": "boolean",
|
|
"default": true
|
|
},
|
|
"config": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"BotRegistrationRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"action"
|
|
],
|
|
"properties": {
|
|
"action": {
|
|
"type": "string",
|
|
"enum": [
|
|
"start",
|
|
"poll"
|
|
]
|
|
},
|
|
"platform_config": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
},
|
|
"registration_code": {
|
|
"type": "string"
|
|
},
|
|
"device_code": {
|
|
"type": "string"
|
|
},
|
|
"qrcode": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
},
|
|
"EnabledPatch": {
|
|
"type": "object",
|
|
"required": [
|
|
"enabled"
|
|
],
|
|
"properties": {
|
|
"enabled": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ProviderSourceConfigRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"config"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"config": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ProviderConfigRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"config"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"provider_source_id": {
|
|
"type": "string"
|
|
},
|
|
"capability": {
|
|
"$ref": "#/components/schemas/ProviderCapability"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean",
|
|
"default": true
|
|
},
|
|
"config": {
|
|
"$ref": "#/components/schemas/DynamicConfig"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ChatRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"message"
|
|
],
|
|
"properties": {
|
|
"username": {
|
|
"type": "string"
|
|
},
|
|
"session_id": {
|
|
"type": "string"
|
|
},
|
|
"conversation_id": {
|
|
"type": "string",
|
|
"description": "Deprecated alias for session_id."
|
|
},
|
|
"message": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/MessagePart"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"config_id": {
|
|
"type": "string"
|
|
},
|
|
"config_name": {
|
|
"type": "string"
|
|
},
|
|
"selected_provider": {
|
|
"type": "string"
|
|
},
|
|
"selected_model": {
|
|
"type": "string"
|
|
},
|
|
"enable_streaming": {
|
|
"type": "boolean",
|
|
"default": true
|
|
},
|
|
"_skip_user_history": {
|
|
"type": "boolean",
|
|
"description": "Internal WebUI flag for edit/regenerate flows."
|
|
},
|
|
"_llm_checkpoint_id": {
|
|
"type": "string",
|
|
"description": "Internal WebUI checkpoint override."
|
|
},
|
|
"_platform_history_id": {
|
|
"type": "string",
|
|
"description": "Internal WebUI platform history override."
|
|
},
|
|
"_thread_selected_text": {
|
|
"type": "string",
|
|
"description": "Internal WebUI side-thread context."
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ChatSessionBatchDeleteRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"session_ids"
|
|
],
|
|
"properties": {
|
|
"session_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ChatSessionPatchRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"display_name": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ChatMessagePatchRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"content"
|
|
],
|
|
"properties": {
|
|
"content": {
|
|
"type": "object",
|
|
"additionalProperties": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ChatMessageRegenerateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"selected_provider": {
|
|
"type": "string"
|
|
},
|
|
"selected_model": {
|
|
"type": "string"
|
|
},
|
|
"enable_streaming": {
|
|
"type": "boolean",
|
|
"default": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ChatThreadCreateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"session_id",
|
|
"parent_message_id",
|
|
"selected_text"
|
|
],
|
|
"properties": {
|
|
"session_id": {
|
|
"type": "string"
|
|
},
|
|
"parent_message_id": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "integer"
|
|
}
|
|
]
|
|
},
|
|
"selected_text": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ChatThreadMessageRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"message"
|
|
],
|
|
"properties": {
|
|
"message": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/MessagePart"
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"selected_provider": {
|
|
"type": "string"
|
|
},
|
|
"selected_model": {
|
|
"type": "string"
|
|
},
|
|
"enable_streaming": {
|
|
"type": "boolean",
|
|
"default": true
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"ChatProjectRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"title": {
|
|
"type": "string"
|
|
},
|
|
"emoji": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"MessagePart": {
|
|
"type": "object",
|
|
"required": [
|
|
"type"
|
|
],
|
|
"properties": {
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"text",
|
|
"plain",
|
|
"image",
|
|
"file",
|
|
"audio",
|
|
"record",
|
|
"video",
|
|
"reply"
|
|
]
|
|
},
|
|
"text": {
|
|
"type": "string"
|
|
},
|
|
"attachment_id": {
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"filename": {
|
|
"type": "string"
|
|
},
|
|
"mime_type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
},
|
|
"ImMessageRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"umo",
|
|
"message"
|
|
],
|
|
"properties": {
|
|
"umo": {
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"oneOf": [
|
|
{
|
|
"type": "string"
|
|
},
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/MessagePart"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PluginUpdateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"reinstall": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PluginBatchUpdateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"plugin_id": {
|
|
"type": "string",
|
|
"description": "When set, update this single plugin instead of a batch."
|
|
},
|
|
"plugin_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"reinstall": {
|
|
"type": "boolean",
|
|
"default": false
|
|
},
|
|
"update_all": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
},
|
|
"PluginVersionSupportRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"astrbot_version": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PluginGithubInstallRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"repository"
|
|
],
|
|
"properties": {
|
|
"repository": {
|
|
"type": "string",
|
|
"description": "GitHub URL or owner/repository slug."
|
|
},
|
|
"ref": {
|
|
"type": "string"
|
|
},
|
|
"download_url": {
|
|
"type": "string",
|
|
"description": "Optional downloadable ZIP URL to use instead of GitHub archive resolution."
|
|
},
|
|
"proxy": {
|
|
"type": "string"
|
|
},
|
|
"ignore_version_check": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PluginUrlInstallRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"url"
|
|
],
|
|
"properties": {
|
|
"url": {
|
|
"type": "string",
|
|
"format": "uri"
|
|
},
|
|
"download_url": {
|
|
"type": "string",
|
|
"format": "uri",
|
|
"description": "Optional downloadable ZIP URL when url is the plugin source page or repository."
|
|
},
|
|
"proxy": {
|
|
"type": "string"
|
|
},
|
|
"ignore_version_check": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PluginUploadInstallRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"file"
|
|
],
|
|
"properties": {
|
|
"file": {
|
|
"type": "string",
|
|
"format": "binary"
|
|
}
|
|
}
|
|
},
|
|
"PluginConfigFileDeleteRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"path"
|
|
],
|
|
"properties": {
|
|
"path": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"PluginSourceRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"url"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"url": {
|
|
"type": "string",
|
|
"format": "uri"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"McpServerConfig": {
|
|
"type": "object",
|
|
"required": [
|
|
"name"
|
|
],
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"enabled": {
|
|
"type": "boolean",
|
|
"default": true
|
|
},
|
|
"transport": {
|
|
"type": "string",
|
|
"enum": [
|
|
"stdio",
|
|
"sse",
|
|
"streamable_http"
|
|
]
|
|
},
|
|
"command": {
|
|
"type": "string"
|
|
},
|
|
"args": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"url": {
|
|
"type": "string"
|
|
},
|
|
"headers": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"timeout": {
|
|
"type": "integer"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
},
|
|
"ModelScopeSyncRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"access_token": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"SkillUploadRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"file"
|
|
],
|
|
"properties": {
|
|
"file": {
|
|
"type": "string",
|
|
"format": "binary"
|
|
},
|
|
"overwrite": {
|
|
"type": "boolean",
|
|
"default": false
|
|
}
|
|
}
|
|
},
|
|
"SkillPatchRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"enabled": {
|
|
"type": "boolean"
|
|
},
|
|
"display_name": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"NeoCandidateActionRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"candidate_id"
|
|
],
|
|
"properties": {
|
|
"candidate_id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
},
|
|
"NeoReleaseActionRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"release_id"
|
|
],
|
|
"properties": {
|
|
"release_id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
},
|
|
"PersonaRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"persona_id",
|
|
"system_prompt"
|
|
],
|
|
"properties": {
|
|
"persona_id": {
|
|
"type": "string"
|
|
},
|
|
"system_prompt": {
|
|
"type": "string"
|
|
},
|
|
"begin_dialogs": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"folder_id": {
|
|
"type": "string"
|
|
},
|
|
"tools": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"skills": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"custom_error_message": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
},
|
|
"PersonaFolderRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"parent_id": {
|
|
"type": "string"
|
|
},
|
|
"description": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
},
|
|
"PersonaMoveRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"persona_id"
|
|
],
|
|
"properties": {
|
|
"persona_id": {
|
|
"type": "string"
|
|
},
|
|
"folder_id": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
},
|
|
"ReorderRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"items"
|
|
],
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"type",
|
|
"sort_order"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"enum": [
|
|
"persona",
|
|
"folder"
|
|
]
|
|
},
|
|
"sort_order": {
|
|
"type": "integer"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"T2iTemplateRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"name",
|
|
"content"
|
|
],
|
|
"properties": {
|
|
"name": {
|
|
"type": "string"
|
|
},
|
|
"content": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
},
|
|
"T2iTemplateContentRequest": {
|
|
"type": "object",
|
|
"required": [
|
|
"content"
|
|
],
|
|
"properties": {
|
|
"content": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"additionalProperties": true
|
|
}
|
|
}
|
|
}
|
|
}
|