List embedding models compatible with the KB dimension policy
List embedding models the user can pick at KB-creation time.
Walks the caller’s credentials, looks up each provider’s
embedding model class, gathers its model cards, and projects
each card through the manager’s :class:DimensionPolicy.
Incompatible cards are dropped; matryoshka cards under a
FIXED / LOCKED_BY_EXISTING policy are narrowed to the
locked dimension. Providers that end up with zero compatible
models are omitted from the response entirely.
Args:
user_id (str):
Injected authenticated user ID.
storage (StorageBase):
Injected storage backend used to enumerate credentials.
manager (KnowledgeBaseManagerBase):
Injected knowledge base manager.
Returns:
ListKbEmbeddingModelsResponse:
One entry per credential with at least one compatible
embedding model, plus the policy used for filtering.
GET
/
knowledge_bases
/
embedding_models
List embedding models compatible with the KB dimension policy
curl --request GET \ --url https://api.example.com/knowledge_bases/embedding_models \ --header 'x-user-id: <x-user-id>'
Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.
Response
Successful Response
Response body listing KB-compatible embedding models.
The list is pre-filtered server-side against the manager's
dimension policy. The policy itself is also returned so the
front-end can render an explanatory banner and lock the dimension
selector when applicable.
The dimension policy used to filter the cards; surfaced verbatim so the UI can explain why models were filtered.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"AgentScope","colors":{"primary":"#0064FD","light":"#3B87FF","dark":"#0050CC"},"logo":{"light":"https://mintcdn.com/agentscope-ai-786677c7/ypv6xWD33tVApmTg/logo/agentscope.svg?fit=max\u0026auto=format\u0026n=ypv6xWD33tVApmTg\u0026q=85\u0026s=1c9a848ffa88ffa648f07542fe23e3e7","dark":"https://mintcdn.com/agentscope-ai-786677c7/ypv6xWD33tVApmTg/logo/agentscope.svg?fit=max\u0026auto=format\u0026n=ypv6xWD33tVApmTg\u0026q=85\u0026s=1c9a848ffa88ffa648f07542fe23e3e7"},"favicon":"https://mintcdn.com/agentscope-ai-786677c7/ypv6xWD33tVApmTg/logo/agentscope.svg?fit=max\u0026auto=format\u0026n=ypv6xWD33tVApmTg\u0026q=85\u0026s=1c9a848ffa88ffa648f07542fe23e3e7","navbar":{},"footer":{"socials":{"x":"https://x.com/agentscope","github":"https://github.com/agentscope-ai","discord":"https://discord.gg/eYMpfnkG8h"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"markdown":{"instructions":["For AgentScope Python, use https://docs.agentscope.io/stable/en/index for new projects. For existing projects, check the installed agentscope version and use matching versioned documentation.","The /latest/ alias points to the newest documentation and may move ahead of /stable/ when a development version exists. Do not mix AgentScope 1.x and 2.x APIs.","State the AgentScope version when providing installation commands or code examples. ReMe uses its own continuously updated /reme/latest/ documentation."]},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Home Page","icon":"book-open-cover","href":"https://agentscope.io/"},{"anchor":"Blog","icon":"newspaper","href":"https://agentscope.io/blog/"}]},"languages":[{"language":"en","default":true,"href":"en/versions/2.0.12dev"},{"language":"zh","href":"zh/versions/2.0.12dev"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"agentscope-ai-786677c7","hasAudioNarration":false,"actualSubdomain":"agentscope-ai-786677c7","customDomains":["docs.agentscope.io"],"gitSource":{"type":"github","owner":"agentscope-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae020fa971f41769d3546e9","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"en","tag":"AgentScope","count":519},{"language":"zh","tag":"AgentScope","count":487},{"language":"en","tag":"Building Blocks","count":326},{"language":"zh","tag":"核心模块","count":319},{"language":"en","tag":"Agent as Service","count":112},{"language":"zh","tag":"智能体即服务","count":112},{"language":"default","tag":"AgentScope","count":101},{"language":"default","tag":"API","count":101},{"language":"default","tag":"Agent as Service","count":72},{"language":"en","tag":"Channel","count":41},{"language":"zh","tag":"消息渠道","count":41},{"language":"en","tag":"Agent","count":40},{"language":"en","tag":"Tool","count":40},{"language":"zh","tag":"智能体","count":40},{"language":"zh","tag":"工具","count":40},{"language":"en","tag":"Get Started","count":38},{"language":"zh","tag":"快速开始","count":36},{"language":"en","tag":"Model","count":34},{"language":"zh","tag":"模型","count":34},{"language":"en","tag":"Context","count":32},{"language":"en","tag":"Permission System","count":32},{"language":"zh","tag":"上下文管理","count":32},{"language":"zh","tag":"权限系统","count":32},{"language":"default","tag":"Deploy \u0026 Serve","count":29},{"language":"default","tag":"knowledge_bases","count":16},{"language":"default","tag":"channels","count":14},{"language":"default","tag":"workspace","count":13},{"language":"default","tag":"sop","count":11},{"language":"default","tag":"hub","count":8},{"language":"default","tag":"sessions","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","slug":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","pageMetadata":{"title":"List embedding models compatible with the KB dimension policy","description":"List embedding models the user can pick at KB-creation time.\n\nWalks the caller's credentials, looks up each provider's\nembedding model class, gathers its model cards, and projects\neach card through the manager's :class:`DimensionPolicy`.\nIncompatible cards are dropped; matryoshka cards under a\n``FIXED`` / ``LOCKED_BY_EXISTING`` policy are narrowed to the\nlocked dimension. Providers that end up with zero compatible\nmodels are omitted from the response entirely.\n\nArgs:\n user_id (`str`):\n Injected authenticated user ID.\n storage (`StorageBase`):\n Injected storage backend used to enumerate credentials.\n manager (`KnowledgeBaseManagerBase`):\n Injected knowledge base manager.\n\nReturns:\n `ListKbEmbeddingModelsResponse`:\n One entry per credential with at least one compatible\n embedding model, plus the policy used for filtering.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"List embedding models the user can pick at KB-creation time.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Walks the caller’s credentials, looks up each provider’s\\nembedding model class, gathers its model cards, and projects\\neach card through the manager’s :class:\", _jsx(_components.code, {\n children: \"DimensionPolicy\"\n }), \".\\nIncompatible cards are dropped; matryoshka cards under a\\n\", _jsx(_components.code, {\n children: \"FIXED\"\n }), \" / \", _jsx(_components.code, {\n children: \"LOCKED_BY_EXISTING\"\n }), \" policy are narrowed to the\\nlocked dimension. Providers that end up with zero compatible\\nmodels are omitted from the response entirely.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Args:\\nuser_id (\", _jsx(_components.code, {\n children: \"str\"\n }), \"):\\nInjected authenticated user ID.\\nstorage (\", _jsx(_components.code, {\n children: \"StorageBase\"\n }), \"):\\nInjected storage backend used to enumerate credentials.\\nmanager (\", _jsx(_components.code, {\n children: \"KnowledgeBaseManagerBase\"\n }), \"):\\nInjected knowledge base manager.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Returns:\\n\", _jsx(_components.code, {\n children: \"ListKbEmbeddingModelsResponse\"\n }), \":\\nOne entry per credential with at least one compatible\\nembedding model, plus the policy used for filtering.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List embedding models compatible with the KB dimension policy","description":"List embedding models the user can pick at KB-creation time.\n\nWalks the caller's credentials, looks up each provider's\nembedding model class, gathers its model cards, and projects\neach card through the manager's :class:`DimensionPolicy`.\nIncompatible cards are dropped; matryoshka cards under a\n``FIXED`` / ``LOCKED_BY_EXISTING`` policy are narrowed to the\nlocked dimension. Providers that end up with zero compatible\nmodels are omitted from the response entirely.\n\nArgs:\n user_id (`str`):\n Injected authenticated user ID.\n storage (`StorageBase`):\n Injected storage backend used to enumerate credentials.\n manager (`KnowledgeBaseManagerBase`):\n Injected knowledge base manager.\n\nReturns:\n `ListKbEmbeddingModelsResponse`:\n One entry per credential with at least one compatible\n embedding model, plus the policy used for filtering.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["knowledge_bases"],"summary":"List embedding models compatible with the KB dimension policy","description":"List embedding models the user can pick at KB-creation time.\n\nWalks the caller's credentials, looks up each provider's\nembedding model class, gathers its model cards, and projects\neach card through the manager's :class:`DimensionPolicy`.\nIncompatible cards are dropped; matryoshka cards under a\n``FIXED`` / ``LOCKED_BY_EXISTING`` policy are narrowed to the\nlocked dimension. Providers that end up with zero compatible\nmodels are omitted from the response entirely.\n\nArgs:\n user_id (`str`):\n Injected authenticated user ID.\n storage (`StorageBase`):\n Injected storage backend used to enumerate credentials.\n manager (`KnowledgeBaseManagerBase`):\n Injected knowledge base manager.\n\nReturns:\n `ListKbEmbeddingModelsResponse`:\n One entry per credential with at least one compatible\n embedding model, plus the policy used for filtering.","operationId":"list_kb_embedding_models_knowledge_bases_embedding_models_get","parameters":["285a0ed2-1659-4122-bb05-88e276795b06"],"responses":{"200":"6052e20b-8fe7-4e50-b0ae-18ff309b55a1","404":"4118cd92-80e3-4d74-b6dd-265c4a15b145","422":"ab0a40a6-fe6c-4d0b-a457-5e70cb6b10ee"},"method":"get","type":"path","servers":[],"security":[],"path":"/knowledge_bases/embedding_models","baseUrlOptions":[],"title":"List embedding models compatible with the KB dimension policy","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"285a0ed2-1659-4122-bb05-88e276795b06":{"name":"x-user-id","in":"header","required":true,"schema":{"type":"string","description":"Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.","title":"X-User-Id","isRequired":true,"uniqueKey":"","typeLabel":"string"},"description":"Caller's user ID. Temporary header-based identity; will be replaced by JWT auth."}},"responses":{"6052e20b-8fe7-4e50-b0ae-18ff309b55a1":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"providers":{"items":{"properties":{"credential":{"properties":{"data":{"additionalProperties":true,"type":"object","title":"Data","isRequired":true,"uniqueKey":"providers.items.[INDEX].credential.data","typeLabel":"Data · object"},"id":{"type":"string","title":"Id","description":"Unique identifier for the credential.","uniqueKey":"providers.items.[INDEX].credential.id","typeLabel":"string"},"updated_at":{"type":"string","format":"date-time","title":"Updated At","uniqueKey":"providers.items.[INDEX].credential.updated_at","typeLabel":"string\u003cdate-time>"},"created_at":{"type":"string","format":"date-time","title":"Created At","uniqueKey":"providers.items.[INDEX].credential.created_at","typeLabel":"string\u003cdate-time>"},"user_id":{"type":"string","title":"User Id","uniqueKey":"providers.items.[INDEX].credential.user_id","typeLabel":"string"}},"type":"object","required":["data"],"title":"CredentialRecord","description":"The credential record exposing these models.","isRequired":true,"uniqueKey":"providers.items.[INDEX].credential","typeLabel":"CredentialRecord · object"},"models":{"items":{"properties":{"name":{"type":"string","title":"Name","description":"The model name used in API calls.","isRequired":true,"uniqueKey":"providers.items.[INDEX].models.items.[INDEX].name","typeLabel":"string"},"label":{"type":"string","title":"Label","description":"Human-readable label for the frontend.","isRequired":true,"uniqueKey":"providers.items.[INDEX].models.items.[INDEX].label","typeLabel":"string"},"dimensions":{"type":"integer","exclusiveMinimum":0,"title":"Dimensions","description":"Default output vector dimensions for this model.","isRequired":true,"uniqueKey":"providers.items.[INDEX].models.items.[INDEX].dimensions","typeLabel":"integer"},"type":{"type":"string","const":"embedding_model","title":"Type","default":"embedding_model","uniqueKey":"providers.items.[INDEX].models.items.[INDEX].type","typeLabel":"string"},"status":{"type":"string","enum":["active","deprecated","sunset"],"title":"Status","description":"The model lifecycle status.","default":"active","uniqueKey":"providers.items.[INDEX].models.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"input_types":{"items":{"type":"string","uniqueKey":"providers.items.[INDEX].models.items.[INDEX].input_types.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Input Types","description":"Supported input media types.","default":["text/plain"],"uniqueKey":"providers.items.[INDEX].models.items.[INDEX].input_types","typeLabel":"string[]"},"output_types":{"items":{"type":"string","uniqueKey":"providers.items.[INDEX].models.items.[INDEX].output_types.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Output Types","description":"Supported output media types.","default":["application/x-embedding"],"uniqueKey":"providers.items.[INDEX].models.items.[INDEX].output_types","typeLabel":"string[]"},"supported_dimensions":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"providers.items.[INDEX].models.items.[INDEX].supported_dimensions.oneOf.0.items.[INDEX]","typeLabel":"integer"},"title":"Supported Dimensions","description":"If set, the only dimensions this model can produce. ``None`` means dimensions are fixed at :attr:`dimensions` and cannot be overridden.","uniqueKey":"providers.items.[INDEX].models.items.[INDEX].supported_dimensions.oneOf.0","typeLabel":"integer[]"},{"type":"null","title":"Supported Dimensions","description":"If set, the only dimensions this model can produce. ``None`` means dimensions are fixed at :attr:`dimensions` and cannot be overridden.","uniqueKey":"providers.items.[INDEX].models.items.[INDEX].supported_dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"providers.items.[INDEX].models.items.[INDEX].supported_dimensions","typeLabel":"integer[] | null"},"context_size":{"oneOf":[{"type":"integer","title":"Context Size","description":"Maximum input length (in tokens) per request.","minimum":0,"exclusiveMinimum":true,"uniqueKey":"providers.items.[INDEX].models.items.[INDEX].context_size.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Context Size","description":"Maximum input length (in tokens) per request.","uniqueKey":"providers.items.[INDEX].models.items.[INDEX].context_size.oneOf.1","typeLabel":"null"}],"uniqueKey":"providers.items.[INDEX].models.items.[INDEX].context_size","typeLabel":"integer | null"},"parameter_schema":{"additionalProperties":true,"type":"object","title":"Parameter Schema","description":"JSON Schema for user-configurable parameters (built from the Parameters class + YAML overrides).","uniqueKey":"providers.items.[INDEX].models.items.[INDEX].parameter_schema","typeLabel":"Parameter Schema · object"},"parameter_overrides":{"additionalProperties":{"additionalProperties":true,"type":"object","uniqueKey":"providers.items.[INDEX].models.items.[INDEX].parameter_overrides.additionalProperties","typeLabel":"object"},"type":"object","title":"Parameter Overrides","description":"Raw parameter overrides from the YAML file.","uniqueKey":"providers.items.[INDEX].models.items.[INDEX].parameter_overrides","typeLabel":"Parameter Overrides · object"}},"type":"object","required":["name","label","dimensions"],"title":"EmbeddingModelCard","description":"A card describing an embedding model's capabilities.\n\nMirrors :class:`~agentscope.model.ModelCard` but tailored for\nembedding models. Uses ``input_types`` / ``output_types`` to\ndescribe model capabilities, and ``parameter_schema`` (built from\nthe embedding class's ``Parameters`` + YAML ``parameter_overrides``)\nto tell the frontend which knobs the user can adjust.\n\nThe output type ``application/x-embedding`` indicates that the\nmodel produces dense vector embeddings.","uniqueKey":"providers.items.[INDEX].models.items.[INDEX]","typeLabel":"EmbeddingModelCard · object"},"type":"array","title":"Models","description":"Embedding model cards available under this credential, filtered to those compatible with the manager's dimension policy.","isRequired":true,"uniqueKey":"providers.items.[INDEX].models","typeLabel":"EmbeddingModelCard · object[]"}},"type":"object","required":["credential","models"],"title":"KbEmbeddingProvider","description":"One credential and the embedding models it can serve.\n\nThe model cards have been projected through the manager's\ndimension policy: incompatible models are removed and matryoshka\ncards are narrowed to the locked dimension when applicable.","uniqueKey":"providers.items.[INDEX]","typeLabel":"KbEmbeddingProvider · object"},"type":"array","title":"Providers","description":"One entry per credential that has at least one compatible embedding model.","isRequired":true,"uniqueKey":"providers","typeLabel":"KbEmbeddingProvider · object[]"},"policy":{"properties":{"kind":{"type":"string","enum":["any","fixed","locked_by_existing"],"title":"DimensionPolicyKind","description":"What constraint applies to the chosen dimension.","isRequired":true,"uniqueKey":"policy.kind","typeLabel":"enum\u003cstring>"},"dimension":{"oneOf":[{"type":"integer","title":"Dimension","description":"The required dimension when ``kind`` is ``FIXED`` or ``LOCKED_BY_EXISTING``. Always ``None`` for ``ANY``.","uniqueKey":"policy.dimension.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Dimension","description":"The required dimension when ``kind`` is ``FIXED`` or ``LOCKED_BY_EXISTING``. Always ``None`` for ``ANY``.","uniqueKey":"policy.dimension.oneOf.1","typeLabel":"null"}],"uniqueKey":"policy.dimension","typeLabel":"integer | null"}},"type":"object","required":["kind"],"title":"DimensionPolicy","description":"The dimension policy used to filter the cards; surfaced verbatim so the UI can explain *why* models were filtered.","isRequired":true,"uniqueKey":"policy","typeLabel":"DimensionPolicy · object"}},"type":"object","required":["providers","policy"],"title":"ListKbEmbeddingModelsResponse","description":"Response body listing KB-compatible embedding models.\n\nThe list is pre-filtered server-side against the manager's\ndimension policy. The policy itself is also returned so the\nfront-end can render an explanatory banner and lock the dimension\nselector when applicable.","uniqueKey":"","typeLabel":"ListKbEmbeddingModelsResponse · object"},"examples":{"Example":{"title":"Example","value":{"providers":[{"credential":{"data":{},"id":"\u003cstring>","updated_at":"2023-11-07T05:31:56Z","created_at":"2023-11-07T05:31:56Z","user_id":"\u003cstring>"},"models":[{"name":"\u003cstring>","label":"\u003cstring>","dimensions":123,"type":"embedding_model","status":"active","input_types":["text/plain"],"output_types":["application/x-embedding"],"supported_dimensions":[123],"context_size":1,"parameter_schema":{},"parameter_overrides":{}}]}],"policy":{"kind":"any","dimension":123}}}},"exampleType":"generated"}},"exampleType":"generated"},"4118cd92-80e3-4d74-b6dd-265c4a15b145":{"description":"Not found","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"ab0a40a6-fe6c-4d0b-a457-5e70cb6b10ee":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{}},"originalFileLocation":"en/versions/2.0.3/deploy/openapi.json"},"subdomain":"agentscope-ai-786677c7","siteName":"AgentScope","title":"List embedding models compatible with the KB dimension policy - AgentScope","navMaps":{"firstHrefInVersion":{"2.0.12dev":{"href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","matchLevel":0},"2.0.11":{"href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","matchLevel":0},"2.0.10":{"href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","matchLevel":0},"2.0.9":{"href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","matchLevel":0},"2.0.8":{"href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","matchLevel":0},"2.0.7":{"href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","matchLevel":0},"2.0.6":{"href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","matchLevel":0},"2.0.5":{"href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","matchLevel":0},"2.0.4":{"href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","matchLevel":0},"2.0.3":{"href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","matchLevel":0},"2.0.2":{"href":"/en/versions/2.0.2","matchLevel":3},"1.0.21":{"href":"/en/versions/1.0.21","matchLevel":3},"latest":{"href":"/en/reme/latest/overview","matchLevel":4}},"firstHrefInLanguage":{"en":{"href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","matchLevel":0},"zh":{"href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy","matchLevel":0}}},"lastModified":"2026-07-08T09:10:39.230Z","originalFileLocation":"api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"List embedding models the user can pick at KB-creation time. Walks the caller\u0026#x27;s credentials, looks up each provider\u0026#x27;s embedding model class, gathers its model cards, and projects each card through the manager\u0026#x27;s :class:DimensionPolicy. Incompatible cards are dropped; matryoshka cards under a FIXED / LOCKED_BY_EXISTING policy are narrowed to the locked dimension. Providers that end up with zero compatible models are omitted from the response entirely. Args: user_id (str): Injected authenticated user ID. storage (StorageBase): Injected storage backend used to enumerate credentials. manager (KnowledgeBaseManagerBase): Injected knowledge base manager. Returns: ListKbEmbeddingModelsResponse: One entry per credential with at least one compatible embedding model, plus the policy used for filtering.\">\u003cmeta data-mint-head name=\"application-name\" content=\"AgentScope\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/agentscope-ai-786677c7/1CzZcOuOvJAMkPRv/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/agentscope-ai-786677c7/1CzZcOuOvJAMkPRv/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/agentscope-ai-786677c7/1CzZcOuOvJAMkPRv/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/agentscope-ai-786677c7/1CzZcOuOvJAMkPRv/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/agentscope-ai-786677c7/1CzZcOuOvJAMkPRv/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/agentscope-ai-786677c7/1CzZcOuOvJAMkPRv/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/agentscope-ai-786677c7/1CzZcOuOvJAMkPRv/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/agentscope-ai-786677c7/1CzZcOuOvJAMkPRv/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/agentscope-ai-786677c7/1CzZcOuOvJAMkPRv/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List embedding models compatible with the KB dimension policy - AgentScope\">\u003cmeta data-mint-head property=\"og:description\" content=\"List embedding models the user can pick at KB-creation time. Walks the caller\u0026#x27;s credentials, looks up each provider\u0026#x27;s embedding model class, gathers its model cards, and projects each card through the manager\u0026#x27;s :class:DimensionPolicy. Incompatible cards are dropped; matryoshka cards under a FIXED / LOCKED_BY_EXISTING policy are narrowed to the locked dimension. Providers that end up with zero compatible models are omitted from the response entirely. Args: user_id (str): Injected authenticated user ID. storage (StorageBase): Injected storage backend used to enumerate credentials. manager (KnowledgeBaseManagerBase): Injected knowledge base manager. Returns: ListKbEmbeddingModelsResponse: One entry per credential with at least one compatible embedding model, plus the policy used for filtering.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AgentScope\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.agentscope.io/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://agentscope-ai-786677c7.mintlify.site/_mintlify/api/og/v2?division=knowledge_bases\u0026amp;title=List+embedding+models+compatible+with+the+KB+dimension+policy\u0026amp;description=List+embedding+models+the+user+can+pick+at+KB-creation+time.%0A%0AWalks+the+caller%27s+credentials%2C+looks+up+each+provider%27s%0Aembedding+model+class%2C+gathers+its+model+\u0026amp;theme=f2d8e9809b723a2634402277\u0026amp;signature=e8c2dbad76d3ffc853e5dce3f71774e2fcc4084a6a25de1d3a107af7f0d6f3bc\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List embedding models compatible with the KB dimension policy - AgentScope\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List embedding models the user can pick at KB-creation time. Walks the caller\u0026#x27;s credentials, looks up each provider\u0026#x27;s embedding model class, gathers its model cards, and projects each card through the manager\u0026#x27;s :class:DimensionPolicy. Incompatible cards are dropped; matryoshka cards under a FIXED / LOCKED_BY_EXISTING policy are narrowed to the locked dimension. Providers that end up with zero compatible models are omitted from the response entirely. Args: user_id (str): Injected authenticated user ID. storage (StorageBase): Injected storage backend used to enumerate credentials. manager (KnowledgeBaseManagerBase): Injected knowledge base manager. Returns: ListKbEmbeddingModelsResponse: One entry per credential with at least one compatible embedding model, plus the policy used for filtering.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://agentscope-ai-786677c7.mintlify.site/_mintlify/api/og/v2?division=knowledge_bases\u0026amp;title=List+embedding+models+compatible+with+the+KB+dimension+policy\u0026amp;description=List+embedding+models+the+user+can+pick+at+KB-creation+time.%0A%0AWalks+the+caller%27s+credentials%2C+looks+up+each+provider%27s%0Aembedding+model+class%2C+gathers+its+model+\u0026amp;theme=f2d8e9809b723a2634402277\u0026amp;signature=e8c2dbad76d3ffc853e5dce3f71774e2fcc4084a6a25de1d3a107af7f0d6f3bc\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/agentscope-ai-786677c7/1CzZcOuOvJAMkPRv/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"AgentScope\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0064FD\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.agentscope.io/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.agentscope.io/#organization\",\"name\":\"AgentScope\",\"url\":\"https://docs.agentscope.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/agentscope-ai-786677c7/ypv6xWD33tVApmTg/logo/agentscope.svg?fit=max\u0026auto=format\u0026n=ypv6xWD33tVApmTg\u0026q=85\u0026s=1c9a848ffa88ffa648f07542fe23e3e7\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.agentscope.io#website\",\"name\":\"AgentScope\",\"url\":\"https://docs.agentscope.io\",\"publisher\":{\"@id\":\"https://docs.agentscope.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.agentscope.io/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy#webpage\",\"url\":\"https://docs.agentscope.io/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy\",\"name\":\"List embedding models compatible with the KB dimension policy\",\"description\":\"List embedding models the user can pick at KB-creation time. Walks the caller's credentials, looks up each provider's embedding model class, gathers its model cards, and projects each card through the manager's :class:DimensionPolicy. Incompatible cards are dropped; matryoshka cards under a FIXED / LOCKED_BY_EXISTING policy are narrowed to the locked dimension. Providers that end up with zero compatible models are omitted from the response entirely. Args: user_id (str): Injected authenticated user ID. storage (StorageBase): Injected storage backend used to enumerate credentials. manager (KnowledgeBaseManagerBase): Injected knowledge base manager. Returns: ListKbEmbeddingModelsResponse: One entry per credential with at least one compatible embedding model, plus the policy used for filtering.\",\"dateModified\":\"2026-07-08T09:10:39.230Z\",\"isPartOf\":{\"@id\":\"https://docs.agentscope.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.agentscope.io/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.agentscope.io/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agent as Service\",\"item\":\"https://docs.agentscope.io/en/versions/2.0.12dev/deploy/agent-service\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API\",\"item\":\"https://docs.agentscope.io/api-reference/agent/[deprecated]-legacy-sectioned-schema-%E2%80%94-use-schemav2\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List embedding models compatible with the KB dimension policy\",\"item\":\"https://docs.agentscope.io/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.agentscope.io/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy#apireference\",\"headline\":\"List embedding models compatible with the KB dimension policy\",\"name\":\"List embedding models compatible with the KB dimension policy\",\"description\":\"List embedding models the user can pick at KB-creation time. Walks the caller's credentials, looks up each provider's embedding model class, gathers its model cards, and projects each card through the manager's :class:DimensionPolicy. Incompatible cards are dropped; matryoshka cards under a FIXED / LOCKED_BY_EXISTING policy are narrowed to the locked dimension. Providers that end up with zero compatible models are omitted from the response entirely. Args: user_id (str): Injected authenticated user ID. storage (StorageBase): Injected storage backend used to enumerate credentials. manager (KnowledgeBaseManagerBase): Injected knowledge base manager. Returns: ListKbEmbeddingModelsResponse: One entry per credential with at least one compatible embedding model, plus the policy used for filtering.\",\"url\":\"https://docs.agentscope.io/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy\",\"mainEntityOfPage\":{\"@id\":\"https://docs.agentscope.io/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy#webpage\"},\"dateModified\":\"2026-07-08T09:10:39.230Z\",\"publisher\":{\"@id\":\"https://docs.agentscope.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.agentscope.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"AgentScope\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"AgentScope\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy.md","siteName":"AgentScope","nav":{"global":{"anchors":[{"anchor":"Home Page","icon":"book-open-cover","href":"https://agentscope.io/"},{"anchor":"Blog","icon":"newspaper","href":"https://agentscope.io/blog/"}]},"languages":[{"language":"en","default":true,"tabs":[{"tab":"AgentScope","versions":[{"version":"2.0.12dev","tag":"Development","groups":[{"group":"Get Started","pages":[{"title":"What's AgentScope 2.0?","href":"/en/versions/2.0.12dev"},{"title":"Quickstart","href":"/en/versions/2.0.12dev/quickstart"},{"title":"Release Notes","href":"/en/versions/2.0.12dev/release-notes"}]},{"group":"Building Blocks","pages":[{"title":"Message \u0026 Event","href":"/en/versions/2.0.12dev/building-blocks/message-and-event"},{"group":"Agent","pages":[{"title":"Overview","href":"/en/versions/2.0.12dev/building-blocks/agent/overview"},{"title":"Configure Agent","href":"/en/versions/2.0.12dev/building-blocks/agent/configure-agent"},{"title":"Run Agent","href":"/en/versions/2.0.12dev/building-blocks/agent/run-agent"},{"title":"Interrupt Agent","href":"/en/versions/2.0.12dev/building-blocks/agent/interrupt-agent"},{"title":"Human-in-the-Loop","href":"/en/versions/2.0.12dev/building-blocks/agent/human-in-the-loop"}]},{"group":"Model","pages":[{"title":"Overview","href":"/en/versions/2.0.12dev/building-blocks/model/overview"},{"title":"LLM","href":"/en/versions/2.0.12dev/building-blocks/model/llm"},{"title":"TTS","href":"/en/versions/2.0.12dev/building-blocks/model/tts"},{"title":"ASR","href":"/en/versions/2.0.12dev/building-blocks/model/asr"},{"title":"Embedding","href":"/en/versions/2.0.12dev/building-blocks/model/embedding"}]},{"group":"Context","pages":[{"title":"Overview","href":"/en/versions/2.0.12dev/building-blocks/context/overview"},{"title":"Environment Awareness","href":"/en/versions/2.0.12dev/building-blocks/context/environment-awareness"},{"title":"Compress Context","href":"/en/versions/2.0.12dev/building-blocks/context/compress-context"},{"title":"Offload Context","href":"/en/versions/2.0.12dev/building-blocks/context/offload-context"}]},{"group":"Tool","pages":[{"title":"Overview","href":"/en/versions/2.0.12dev/building-blocks/tool/overview"},{"title":"Python Tool","href":"/en/versions/2.0.12dev/building-blocks/tool/python-tool"},{"title":"MCP","href":"/en/versions/2.0.12dev/building-blocks/tool/mcp"},{"title":"Skill","href":"/en/versions/2.0.12dev/building-blocks/tool/skill"},{"title":"Meta Tool","href":"/en/versions/2.0.12dev/building-blocks/tool/manage-tools"}]},{"title":"Plan","href":"/en/versions/2.0.12dev/building-blocks/plan"},{"group":"Pipeline","tag":"EXP","pages":[{"title":"Overview","href":"/en/versions/2.0.12dev/building-blocks/pipeline/overview"},{"title":"Goal Pipeline","href":"/en/versions/2.0.12dev/building-blocks/pipeline/goal"},{"title":"Team Pipeline","href":"/en/versions/2.0.12dev/building-blocks/pipeline/team"}]},{"title":"Standard Operating Procedure","tag":"EXP","href":"/en/versions/2.0.12dev/building-blocks/sop"},{"group":"Permission System","pages":[{"title":"Overview","href":"/en/versions/2.0.12dev/building-blocks/permission-system/overview"},{"title":"Permission Mode","href":"/en/versions/2.0.12dev/building-blocks/permission-system/permission-mode"},{"title":"Permission Rule","href":"/en/versions/2.0.12dev/building-blocks/permission-system/permission-rule"},{"title":"Tool-Level Checks","href":"/en/versions/2.0.12dev/building-blocks/permission-system/tool-check"}]},{"title":"Middleware","href":"/en/versions/2.0.12dev/building-blocks/middleware"},{"title":"RAG","href":"/en/versions/2.0.12dev/building-blocks/rag"},{"title":"Long-Term Memory","href":"/en/versions/2.0.12dev/building-blocks/long-term-memory"},{"group":"Workspace","pages":[{"title":"Overview","href":"/en/versions/2.0.12dev/building-blocks/workspace/overview"},{"title":"Run Workspace","href":"/en/versions/2.0.12dev/building-blocks/workspace/run-workspace"},{"title":"Manage Resources","href":"/en/versions/2.0.12dev/building-blocks/workspace/manage-resources"},{"title":"MCP Gateway","href":"/en/versions/2.0.12dev/building-blocks/workspace/mcp-gateway"}]},{"group":"Realtime Agent","tag":"EXP","pages":[{"title":"Overview","href":"/en/versions/2.0.12dev/building-blocks/realtime/overview"},{"title":"Speech-to-Speech","href":"/en/versions/2.0.12dev/building-blocks/realtime/speech-to-speech"}]},{"title":"Console","href":"/en/versions/2.0.12dev/building-blocks/console"},{"title":"A2A Protocol","href":"/en/versions/2.0.12dev/building-blocks/a2a"}]},{"group":"Agent as Service","pages":[{"title":"Architecture","href":"/en/versions/2.0.12dev/deploy/agent-service"},{"title":"Agent Team","href":"/en/versions/2.0.12dev/deploy/agent-team"},{"title":"SOP Service","tag":"EXP","href":"/en/versions/2.0.12dev/deploy/sop"},{"title":"Resource Sharing","tag":"NEW","href":"/en/versions/2.0.12dev/deploy/sharing"},{"title":"RAG Service","href":"/en/versions/2.0.12dev/deploy/rag"},{"title":"Workspace Manager","href":"/en/versions/2.0.12dev/deploy/workspace-manager"},{"group":"MCP \u0026 Skill Hub","pages":[{"title":"Overview","href":"/en/versions/2.0.12dev/deploy/hub/overview"},{"title":"MCP Hub","href":"/en/versions/2.0.12dev/deploy/hub/mcp-hub"},{"title":"Skill Hub","href":"/en/versions/2.0.12dev/deploy/hub/skill-hub"}]},{"group":"Channel","pages":[{"title":"Overview","href":"/en/versions/2.0.12dev/deploy/channel/overview"},{"title":"Message Routing","href":"/en/versions/2.0.12dev/deploy/channel/routing"},{"title":"Feishu","href":"/en/versions/2.0.12dev/deploy/channel/feishu"},{"title":"DingTalk","href":"/en/versions/2.0.12dev/deploy/channel/dingtalk"},{"title":"Discord","href":"/en/versions/2.0.12dev/deploy/channel/discord"},{"title":"Custom Channel","href":"/en/versions/2.0.12dev/deploy/channel/custom"}]},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"health","pages":[{"title":"Report service liveness and per-component readiness","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /health","href":"/api-reference/health/report-service-liveness-and-per-component-readiness"}]},{"group":"hub","pages":[{"title":"List Mcp Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp","href":"/api-reference/hub/list-mcp-hubs"},{"title":"List Mcp Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards","href":"/api-reference/hub/list-mcp-cards"},{"title":"Get Mcp Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-mcp-card"},{"title":"Install Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/mcp/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-mcp"},{"title":"List Skill Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill","href":"/api-reference/hub/list-skill-hubs"},{"title":"List Skill Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards","href":"/api-reference/hub/list-skill-cards"},{"title":"Install Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/skill/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-skill"},{"title":"Get Skill Card","description":"Return one skill card, including its ``SKILL.md`` body.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-skill-card"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"List available chunker types and their parameter schemas","description":"List every available chunker type with its parameter schema.\n\nThe front-end uses this to populate the chunker selector and\nto render a dynamic parameter form when creating a knowledge\nbase.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n chunker_classes (`list[type[ChunkerBase]]`):\n The chunker classes configured via\n ``create_app(knowledge_chunkers=...)``.\n\nReturns:\n `ListChunkersResponse`:\n All available chunker types with their JSON Schemas.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/chunkers","href":"/api-reference/knowledge_bases/list-available-chunker-types-and-their-parameter-schemas"},{"title":"JSON Schema for the KB middleware's tunable parameters","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Fetch the original uploaded file of a document","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/fetch-the-original-uploaded-file-of-a-document"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"},{"title":"Browse one document's chunks in order","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}/chunks","href":"/api-reference/knowledge_bases/browse-one-documents-chunks-in-order"},{"title":"Mint a short-lived token for a browser-native fetch","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents/{document_id}/download_token","href":"/api-reference/knowledge_bases/mint-a-short-lived-token-for-a-browser-native-fetch"}]},{"group":"mcp","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /mcp","href":"/api-reference/mcp/list-mcps"},{"title":"Delete Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /mcp/{mcp_id}","href":"/api-reference/mcp/delete-mcp"},{"title":"Update Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /mcp/{mcp_id}","href":"/api-reference/mcp/update-mcp"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"skill","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill","href":"/api-reference/skill/list-skills"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill/{skill_id}","href":"/api-reference/skill/get-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /skill/{skill_id}","href":"/api-reference/skill/delete-skill"}]},{"group":"sop","pages":[{"title":"The schema a procedure's editor is built from","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/schema","href":"/api-reference/sop/the-schema-a-procedures-editor-is-built-from"},{"title":"List procedures","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/","href":"/api-reference/sop/list-procedures"},{"title":"Create a procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/","href":"/api-reference/sop/create-a-procedure"},{"title":"List runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs","href":"/api-reference/sop/list-runs"},{"title":"Read one run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs/{sop_run_id}","href":"/api-reference/sop/read-one-run"},{"title":"Delete a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/runs/{sop_run_id}","href":"/api-reference/sop/delete-a-run"},{"title":"File a person's verdict on a step","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/runs/{sop_run_id}/verdict","href":"/api-reference/sop/file-a-persons-verdict-on-a-step"},{"title":"Read one procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/{sop_id}","href":"/api-reference/sop/read-one-procedure"},{"title":"Delete a procedure and its runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/{sop_id}","href":"/api-reference/sop/delete-a-procedure-and-its-runs"},{"title":"Replace a procedure's contents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json patch /sop/{sop_id}","href":"/api-reference/sop/replace-a-procedures-contents"},{"title":"Start a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/{sop_id}/runs","href":"/api-reference/sop/start-a-run"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Add Mcps From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/mcp/from-library","href":"/api-reference/workspace/add-mcps-from-library"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Upload Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/upload","href":"/api-reference/workspace/upload-skill"},{"title":"Add Skills From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/from-library","href":"/api-reference/workspace/add-skills-from-library"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"},{"title":"List Workspace Directory","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/directories","href":"/api-reference/workspace/list-workspace-directory"},{"title":"Get Workspace Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /workspace/status","href":"/api-reference/workspace/get-workspace-status"},{"title":"Create Download Token","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/files/download-token","href":"/api-reference/workspace/create-download-token"},{"title":"Read Workspace File","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/files","href":"/api-reference/workspace/read-workspace-file"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"realtime","pages":[{"title":"List realtime models for a credential provider","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json get /realtime/models","href":"/api-reference/realtime/list-realtime-models-for-a-credential-provider"},{"title":"Get browser WebRTC configuration","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json get /realtime/config","href":"/api-reference/realtime/get-browser-webrtc-configuration"},{"title":"Start a realtime session from a WebRTC offer","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json post /realtime/sessions/{session_id}/offer","href":"/api-reference/realtime/start-a-realtime-session-from-a-webrtc-offer"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]},{"group":"embedding-model","pages":[{"title":"List all candidate embedding models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /embedding-model/","href":"/api-reference/embedding-model/list-all-candidate-embedding-models-under-the-given-credential-type"}]},{"group":"channels","pages":[{"title":"List Channel Types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/types","href":"/api-reference/channels/list-channel-types"},{"title":"List Channels","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/","href":"/api-reference/channels/list-channels"},{"title":"Create Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/","href":"/api-reference/channels/create-channel"},{"title":"Start Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings","href":"/api-reference/channels/start-credential-binding"},{"title":"Poll Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /channels/bindings/{binding_id}","href":"/api-reference/channels/poll-credential-binding"},{"title":"Cancel Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings/{binding_id}/cancel","href":"/api-reference/channels/cancel-credential-binding"},{"title":"Get Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-channel"},{"title":"Delete Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-channel"},{"title":"Update Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-channel"},{"title":"Enable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/enable","href":"/api-reference/channels/enable-channel"},{"title":"Disable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/disable","href":"/api-reference/channels/disable-channel"},{"title":"Channel Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/status","href":"/api-reference/channels/channel-status"},{"title":"List Channel Sessions","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/sessions","href":"/api-reference/channels/list-channel-sessions"},{"title":"List Chat Ids","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/chat_ids","href":"/api-reference/channels/list-chat-ids"}]}]}]},{"group":"Others","pages":[{"title":"FAQ","href":"/en/versions/2.0.12dev/others/faq"},{"title":"Changelog","href":"/en/versions/2.0.12dev/others/change-log"}]}]},{"version":"2.0.11","default":true,"groups":[{"group":"Get Started","pages":[{"title":"What's AgentScope 2.0?","href":"/en/versions/2.0.11"},{"title":"Quickstart","href":"/en/versions/2.0.11/quickstart"},{"title":"Release Notes","href":"/en/versions/2.0.11/release-notes"}]},{"group":"Building Blocks","pages":[{"title":"Message \u0026 Event","href":"/en/versions/2.0.11/building-blocks/message-and-event"},{"group":"Agent","pages":[{"title":"Overview","href":"/en/versions/2.0.11/building-blocks/agent/overview"},{"title":"Configure Agent","href":"/en/versions/2.0.11/building-blocks/agent/configure-agent"},{"title":"Run Agent","href":"/en/versions/2.0.11/building-blocks/agent/run-agent"},{"title":"Interrupt Agent","href":"/en/versions/2.0.11/building-blocks/agent/interrupt-agent"},{"title":"Human-in-the-Loop","href":"/en/versions/2.0.11/building-blocks/agent/human-in-the-loop"}]},{"group":"Model","pages":[{"title":"Overview","href":"/en/versions/2.0.11/building-blocks/model/overview"},{"title":"LLM","href":"/en/versions/2.0.11/building-blocks/model/llm"},{"title":"TTS","href":"/en/versions/2.0.11/building-blocks/model/tts"},{"title":"ASR","href":"/en/versions/2.0.11/building-blocks/model/asr"},{"title":"Embedding","href":"/en/versions/2.0.11/building-blocks/model/embedding"}]},{"group":"Context","pages":[{"title":"Overview","href":"/en/versions/2.0.11/building-blocks/context/overview"},{"title":"Environment Awareness","href":"/en/versions/2.0.11/building-blocks/context/environment-awareness"},{"title":"Compress Context","href":"/en/versions/2.0.11/building-blocks/context/compress-context"},{"title":"Offload Context","href":"/en/versions/2.0.11/building-blocks/context/offload-context"}]},{"group":"Tool","pages":[{"title":"Overview","href":"/en/versions/2.0.11/building-blocks/tool/overview"},{"title":"Python Tool","href":"/en/versions/2.0.11/building-blocks/tool/python-tool"},{"title":"MCP","href":"/en/versions/2.0.11/building-blocks/tool/mcp"},{"title":"Skill","href":"/en/versions/2.0.11/building-blocks/tool/skill"},{"title":"Meta Tool","href":"/en/versions/2.0.11/building-blocks/tool/manage-tools"}]},{"title":"Plan","href":"/en/versions/2.0.11/building-blocks/plan"},{"group":"Pipeline","tag":"EXP","pages":[{"title":"Overview","href":"/en/versions/2.0.11/building-blocks/pipeline/overview"},{"title":"Goal Pipeline","href":"/en/versions/2.0.11/building-blocks/pipeline/goal"},{"title":"Team Pipeline","href":"/en/versions/2.0.11/building-blocks/pipeline/team"}]},{"title":"Standard Operating Procedure","tag":"EXP","href":"/en/versions/2.0.11/building-blocks/sop"},{"group":"Permission System","pages":[{"title":"Overview","href":"/en/versions/2.0.11/building-blocks/permission-system/overview"},{"title":"Permission Mode","href":"/en/versions/2.0.11/building-blocks/permission-system/permission-mode"},{"title":"Permission Rule","href":"/en/versions/2.0.11/building-blocks/permission-system/permission-rule"},{"title":"Tool-Level Checks","href":"/en/versions/2.0.11/building-blocks/permission-system/tool-check"}]},{"title":"Middleware","href":"/en/versions/2.0.11/building-blocks/middleware"},{"title":"RAG","href":"/en/versions/2.0.11/building-blocks/rag"},{"title":"Long-Term Memory","href":"/en/versions/2.0.11/building-blocks/long-term-memory"},{"group":"Workspace","pages":[{"title":"Overview","href":"/en/versions/2.0.11/building-blocks/workspace/overview"},{"title":"Run Workspace","href":"/en/versions/2.0.11/building-blocks/workspace/run-workspace"},{"title":"Manage Resources","href":"/en/versions/2.0.11/building-blocks/workspace/manage-resources"},{"title":"MCP Gateway","href":"/en/versions/2.0.11/building-blocks/workspace/mcp-gateway"}]},{"group":"Realtime Agent","tag":"EXP","pages":[{"title":"Overview","href":"/en/versions/2.0.11/building-blocks/realtime/overview"},{"title":"Speech-to-Speech","href":"/en/versions/2.0.11/building-blocks/realtime/speech-to-speech"}]},{"title":"Console","href":"/en/versions/2.0.11/building-blocks/console"},{"title":"A2A Protocol","href":"/en/versions/2.0.11/building-blocks/a2a"}]},{"group":"Agent as Service","pages":[{"title":"Architecture","href":"/en/versions/2.0.11/deploy/agent-service"},{"title":"Agent Team","href":"/en/versions/2.0.11/deploy/agent-team"},{"title":"SOP Service","tag":"EXP","href":"/en/versions/2.0.11/deploy/sop"},{"title":"Resource Sharing","tag":"NEW","href":"/en/versions/2.0.11/deploy/sharing"},{"title":"RAG Service","href":"/en/versions/2.0.11/deploy/rag"},{"title":"Workspace Manager","href":"/en/versions/2.0.11/deploy/workspace-manager"},{"group":"MCP \u0026 Skill Hub","pages":[{"title":"Overview","href":"/en/versions/2.0.11/deploy/hub/overview"},{"title":"MCP Hub","href":"/en/versions/2.0.11/deploy/hub/mcp-hub"},{"title":"Skill Hub","href":"/en/versions/2.0.11/deploy/hub/skill-hub"}]},{"group":"Channel","pages":[{"title":"Overview","href":"/en/versions/2.0.11/deploy/channel/overview"},{"title":"Message Routing","href":"/en/versions/2.0.11/deploy/channel/routing"},{"title":"Feishu","href":"/en/versions/2.0.11/deploy/channel/feishu"},{"title":"DingTalk","href":"/en/versions/2.0.11/deploy/channel/dingtalk"},{"title":"Discord","href":"/en/versions/2.0.11/deploy/channel/discord"},{"title":"Custom Channel","href":"/en/versions/2.0.11/deploy/channel/custom"}]},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"health","pages":[{"title":"Report service liveness and per-component readiness","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /health","href":"/api-reference/health/report-service-liveness-and-per-component-readiness"}]},{"group":"hub","pages":[{"title":"List Mcp Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp","href":"/api-reference/hub/list-mcp-hubs"},{"title":"List Mcp Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards","href":"/api-reference/hub/list-mcp-cards"},{"title":"Get Mcp Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-mcp-card"},{"title":"Install Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/mcp/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-mcp"},{"title":"List Skill Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill","href":"/api-reference/hub/list-skill-hubs"},{"title":"List Skill Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards","href":"/api-reference/hub/list-skill-cards"},{"title":"Install Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/skill/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-skill"},{"title":"Get Skill Card","description":"Return one skill card, including its ``SKILL.md`` body.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-skill-card"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"List available chunker types and their parameter schemas","description":"List every available chunker type with its parameter schema.\n\nThe front-end uses this to populate the chunker selector and\nto render a dynamic parameter form when creating a knowledge\nbase.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n chunker_classes (`list[type[ChunkerBase]]`):\n The chunker classes configured via\n ``create_app(knowledge_chunkers=...)``.\n\nReturns:\n `ListChunkersResponse`:\n All available chunker types with their JSON Schemas.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/chunkers","href":"/api-reference/knowledge_bases/list-available-chunker-types-and-their-parameter-schemas"},{"title":"JSON Schema for the KB middleware's tunable parameters","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Fetch the original uploaded file of a document","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/fetch-the-original-uploaded-file-of-a-document"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"},{"title":"Browse one document's chunks in order","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}/chunks","href":"/api-reference/knowledge_bases/browse-one-documents-chunks-in-order"},{"title":"Mint a short-lived token for a browser-native fetch","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents/{document_id}/download_token","href":"/api-reference/knowledge_bases/mint-a-short-lived-token-for-a-browser-native-fetch"}]},{"group":"mcp","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /mcp","href":"/api-reference/mcp/list-mcps"},{"title":"Delete Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /mcp/{mcp_id}","href":"/api-reference/mcp/delete-mcp"},{"title":"Update Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /mcp/{mcp_id}","href":"/api-reference/mcp/update-mcp"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"skill","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill","href":"/api-reference/skill/list-skills"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill/{skill_id}","href":"/api-reference/skill/get-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /skill/{skill_id}","href":"/api-reference/skill/delete-skill"}]},{"group":"sop","pages":[{"title":"The schema a procedure's editor is built from","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/schema","href":"/api-reference/sop/the-schema-a-procedures-editor-is-built-from"},{"title":"List procedures","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/","href":"/api-reference/sop/list-procedures"},{"title":"Create a procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/","href":"/api-reference/sop/create-a-procedure"},{"title":"List runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs","href":"/api-reference/sop/list-runs"},{"title":"Read one run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs/{sop_run_id}","href":"/api-reference/sop/read-one-run"},{"title":"Delete a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/runs/{sop_run_id}","href":"/api-reference/sop/delete-a-run"},{"title":"File a person's verdict on a step","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/runs/{sop_run_id}/verdict","href":"/api-reference/sop/file-a-persons-verdict-on-a-step"},{"title":"Read one procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/{sop_id}","href":"/api-reference/sop/read-one-procedure"},{"title":"Delete a procedure and its runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/{sop_id}","href":"/api-reference/sop/delete-a-procedure-and-its-runs"},{"title":"Replace a procedure's contents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json patch /sop/{sop_id}","href":"/api-reference/sop/replace-a-procedures-contents"},{"title":"Start a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/{sop_id}/runs","href":"/api-reference/sop/start-a-run"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Add Mcps From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/mcp/from-library","href":"/api-reference/workspace/add-mcps-from-library"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Upload Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/upload","href":"/api-reference/workspace/upload-skill"},{"title":"Add Skills From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/from-library","href":"/api-reference/workspace/add-skills-from-library"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"},{"title":"List Workspace Directory","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/directories","href":"/api-reference/workspace/list-workspace-directory"},{"title":"Get Workspace Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /workspace/status","href":"/api-reference/workspace/get-workspace-status"},{"title":"Create Download Token","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/files/download-token","href":"/api-reference/workspace/create-download-token"},{"title":"Read Workspace File","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/files","href":"/api-reference/workspace/read-workspace-file"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"realtime","pages":[{"title":"List realtime models for a credential provider","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json get /realtime/models","href":"/api-reference/realtime/list-realtime-models-for-a-credential-provider"},{"title":"Get browser WebRTC configuration","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json get /realtime/config","href":"/api-reference/realtime/get-browser-webrtc-configuration"},{"title":"Start a realtime session from a WebRTC offer","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json post /realtime/sessions/{session_id}/offer","href":"/api-reference/realtime/start-a-realtime-session-from-a-webrtc-offer"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]},{"group":"embedding-model","pages":[{"title":"List all candidate embedding models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /embedding-model/","href":"/api-reference/embedding-model/list-all-candidate-embedding-models-under-the-given-credential-type"}]},{"group":"channels","pages":[{"title":"List Channel Types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/types","href":"/api-reference/channels/list-channel-types"},{"title":"List Channels","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/","href":"/api-reference/channels/list-channels"},{"title":"Create Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/","href":"/api-reference/channels/create-channel"},{"title":"Start Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings","href":"/api-reference/channels/start-credential-binding"},{"title":"Poll Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /channels/bindings/{binding_id}","href":"/api-reference/channels/poll-credential-binding"},{"title":"Cancel Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings/{binding_id}/cancel","href":"/api-reference/channels/cancel-credential-binding"},{"title":"Get Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-channel"},{"title":"Delete Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-channel"},{"title":"Update Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-channel"},{"title":"Enable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/enable","href":"/api-reference/channels/enable-channel"},{"title":"Disable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/disable","href":"/api-reference/channels/disable-channel"},{"title":"Channel Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/status","href":"/api-reference/channels/channel-status"},{"title":"List Channel Sessions","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/sessions","href":"/api-reference/channels/list-channel-sessions"},{"title":"List Chat Ids","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/chat_ids","href":"/api-reference/channels/list-chat-ids"}]}]}]},{"group":"Others","pages":[{"title":"FAQ","href":"/en/versions/2.0.11/others/faq"},{"title":"Changelog","href":"/en/versions/2.0.11/others/change-log"}]}]},{"version":"2.0.10","groups":[{"group":"Get Started","pages":[{"title":"What's AgentScope 2.0?","href":"/en/versions/2.0.10"},{"title":"Quickstart","href":"/en/versions/2.0.10/quickstart"},{"title":"Release Notes","href":"/en/versions/2.0.10/release-notes"}]},{"group":"Building Blocks","pages":[{"title":"Message \u0026 Event","href":"/en/versions/2.0.10/building-blocks/message-and-event"},{"group":"Agent","pages":[{"title":"Overview","href":"/en/versions/2.0.10/building-blocks/agent/overview"},{"title":"Configure Agent","href":"/en/versions/2.0.10/building-blocks/agent/configure-agent"},{"title":"Run Agent","href":"/en/versions/2.0.10/building-blocks/agent/run-agent"},{"title":"Interrupt Agent","href":"/en/versions/2.0.10/building-blocks/agent/interrupt-agent"},{"title":"Human-in-the-Loop","href":"/en/versions/2.0.10/building-blocks/agent/human-in-the-loop"}]},{"group":"Model","pages":[{"title":"Overview","href":"/en/versions/2.0.10/building-blocks/model/overview"},{"title":"LLM","href":"/en/versions/2.0.10/building-blocks/model/llm"},{"title":"TTS","href":"/en/versions/2.0.10/building-blocks/model/tts"},{"title":"Embedding","href":"/en/versions/2.0.10/building-blocks/model/embedding"}]},{"group":"Context","pages":[{"title":"Overview","href":"/en/versions/2.0.10/building-blocks/context/overview"},{"title":"Environment Awareness","href":"/en/versions/2.0.10/building-blocks/context/environment-awareness"},{"title":"Compress Context","href":"/en/versions/2.0.10/building-blocks/context/compress-context"},{"title":"Offload Context","href":"/en/versions/2.0.10/building-blocks/context/offload-context"}]},{"group":"Tool","pages":[{"title":"Overview","href":"/en/versions/2.0.10/building-blocks/tool/overview"},{"title":"Python Tool","href":"/en/versions/2.0.10/building-blocks/tool/python-tool"},{"title":"MCP","href":"/en/versions/2.0.10/building-blocks/tool/mcp"},{"title":"Skill","href":"/en/versions/2.0.10/building-blocks/tool/skill"},{"title":"Meta Tool","href":"/en/versions/2.0.10/building-blocks/tool/manage-tools"}]},{"title":"Plan","href":"/en/versions/2.0.10/building-blocks/plan"},{"group":"Pipeline","tag":"EXP","pages":[{"title":"Overview","href":"/en/versions/2.0.10/building-blocks/pipeline/overview"},{"title":"Goal Pipeline","href":"/en/versions/2.0.10/building-blocks/pipeline/goal"},{"title":"Team Pipeline","href":"/en/versions/2.0.10/building-blocks/pipeline/team"}]},{"title":"Standard Operating Procedure","tag":"EXP","href":"/en/versions/2.0.10/building-blocks/sop"},{"group":"Permission System","pages":[{"title":"Overview","href":"/en/versions/2.0.10/building-blocks/permission-system/overview"},{"title":"Permission Mode","href":"/en/versions/2.0.10/building-blocks/permission-system/permission-mode"},{"title":"Permission Rule","href":"/en/versions/2.0.10/building-blocks/permission-system/permission-rule"},{"title":"Tool-Level Checks","href":"/en/versions/2.0.10/building-blocks/permission-system/tool-check"}]},{"title":"Middleware","href":"/en/versions/2.0.10/building-blocks/middleware"},{"title":"RAG","href":"/en/versions/2.0.10/building-blocks/rag"},{"title":"Long-Term Memory","href":"/en/versions/2.0.10/building-blocks/long-term-memory"},{"group":"Workspace","pages":[{"title":"Overview","href":"/en/versions/2.0.10/building-blocks/workspace/overview"},{"title":"Run Workspace","href":"/en/versions/2.0.10/building-blocks/workspace/run-workspace"},{"title":"Manage Resources","href":"/en/versions/2.0.10/building-blocks/workspace/manage-resources"},{"title":"MCP Gateway","href":"/en/versions/2.0.10/building-blocks/workspace/mcp-gateway"}]},{"group":"Realtime Agent","tag":"EXP","pages":[{"title":"Overview","href":"/en/versions/2.0.10/building-blocks/realtime/overview"},{"title":"Speech-to-Speech","href":"/en/versions/2.0.10/building-blocks/realtime/speech-to-speech"}]},{"title":"Console","href":"/en/versions/2.0.10/building-blocks/console"},{"title":"A2A Protocol","href":"/en/versions/2.0.10/building-blocks/a2a"}]},{"group":"Agent as Service","pages":[{"title":"Architecture","href":"/en/versions/2.0.10/deploy/agent-service"},{"title":"Agent Team","href":"/en/versions/2.0.10/deploy/agent-team"},{"title":"SOP Service","tag":"EXP","href":"/en/versions/2.0.10/deploy/sop"},{"title":"Resource Sharing","tag":"NEW","href":"/en/versions/2.0.10/deploy/sharing"},{"title":"RAG Service","href":"/en/versions/2.0.10/deploy/rag"},{"title":"Workspace Manager","href":"/en/versions/2.0.10/deploy/workspace-manager"},{"group":"MCP \u0026 Skill Hub","pages":[{"title":"Overview","href":"/en/versions/2.0.10/deploy/hub/overview"},{"title":"MCP Hub","href":"/en/versions/2.0.10/deploy/hub/mcp-hub"},{"title":"Skill Hub","href":"/en/versions/2.0.10/deploy/hub/skill-hub"}]},{"group":"Channel","pages":[{"title":"Overview","href":"/en/versions/2.0.10/deploy/channel/overview"},{"title":"Message Routing","href":"/en/versions/2.0.10/deploy/channel/routing"},{"title":"Feishu","href":"/en/versions/2.0.10/deploy/channel/feishu"},{"title":"DingTalk","href":"/en/versions/2.0.10/deploy/channel/dingtalk"},{"title":"Discord","href":"/en/versions/2.0.10/deploy/channel/discord"},{"title":"Custom Channel","href":"/en/versions/2.0.10/deploy/channel/custom"}]},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"health","pages":[{"title":"Report service liveness and per-component readiness","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /health","href":"/api-reference/health/report-service-liveness-and-per-component-readiness"}]},{"group":"hub","pages":[{"title":"List Mcp Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp","href":"/api-reference/hub/list-mcp-hubs"},{"title":"List Mcp Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards","href":"/api-reference/hub/list-mcp-cards"},{"title":"Get Mcp Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-mcp-card"},{"title":"Install Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/mcp/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-mcp"},{"title":"List Skill Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill","href":"/api-reference/hub/list-skill-hubs"},{"title":"List Skill Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards","href":"/api-reference/hub/list-skill-cards"},{"title":"Install Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/skill/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-skill"},{"title":"Get Skill Card","description":"Return one skill card, including its ``SKILL.md`` body.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-skill-card"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"List available chunker types and their parameter schemas","description":"List every available chunker type with its parameter schema.\n\nThe front-end uses this to populate the chunker selector and\nto render a dynamic parameter form when creating a knowledge\nbase.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n chunker_classes (`list[type[ChunkerBase]]`):\n The chunker classes configured via\n ``create_app(knowledge_chunkers=...)``.\n\nReturns:\n `ListChunkersResponse`:\n All available chunker types with their JSON Schemas.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/chunkers","href":"/api-reference/knowledge_bases/list-available-chunker-types-and-their-parameter-schemas"},{"title":"JSON Schema for the KB middleware's tunable parameters","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Fetch the original uploaded file of a document","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/fetch-the-original-uploaded-file-of-a-document"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"},{"title":"Browse one document's chunks in order","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}/chunks","href":"/api-reference/knowledge_bases/browse-one-documents-chunks-in-order"},{"title":"Mint a short-lived token for a browser-native fetch","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents/{document_id}/download_token","href":"/api-reference/knowledge_bases/mint-a-short-lived-token-for-a-browser-native-fetch"}]},{"group":"mcp","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /mcp","href":"/api-reference/mcp/list-mcps"},{"title":"Delete Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /mcp/{mcp_id}","href":"/api-reference/mcp/delete-mcp"},{"title":"Update Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /mcp/{mcp_id}","href":"/api-reference/mcp/update-mcp"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"skill","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill","href":"/api-reference/skill/list-skills"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill/{skill_id}","href":"/api-reference/skill/get-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /skill/{skill_id}","href":"/api-reference/skill/delete-skill"}]},{"group":"sop","pages":[{"title":"The schema a procedure's editor is built from","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/schema","href":"/api-reference/sop/the-schema-a-procedures-editor-is-built-from"},{"title":"List procedures","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/","href":"/api-reference/sop/list-procedures"},{"title":"Create a procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/","href":"/api-reference/sop/create-a-procedure"},{"title":"List runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs","href":"/api-reference/sop/list-runs"},{"title":"Read one run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs/{sop_run_id}","href":"/api-reference/sop/read-one-run"},{"title":"Delete a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/runs/{sop_run_id}","href":"/api-reference/sop/delete-a-run"},{"title":"File a person's verdict on a step","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/runs/{sop_run_id}/verdict","href":"/api-reference/sop/file-a-persons-verdict-on-a-step"},{"title":"Read one procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/{sop_id}","href":"/api-reference/sop/read-one-procedure"},{"title":"Delete a procedure and its runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/{sop_id}","href":"/api-reference/sop/delete-a-procedure-and-its-runs"},{"title":"Replace a procedure's contents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json patch /sop/{sop_id}","href":"/api-reference/sop/replace-a-procedures-contents"},{"title":"Start a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/{sop_id}/runs","href":"/api-reference/sop/start-a-run"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Add Mcps From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/mcp/from-library","href":"/api-reference/workspace/add-mcps-from-library"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Upload Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/upload","href":"/api-reference/workspace/upload-skill"},{"title":"Add Skills From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/from-library","href":"/api-reference/workspace/add-skills-from-library"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"},{"title":"List Workspace Directory","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/directories","href":"/api-reference/workspace/list-workspace-directory"},{"title":"Get Workspace Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /workspace/status","href":"/api-reference/workspace/get-workspace-status"},{"title":"Create Download Token","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/files/download-token","href":"/api-reference/workspace/create-download-token"},{"title":"Read Workspace File","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/files","href":"/api-reference/workspace/read-workspace-file"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"realtime","pages":[{"title":"List realtime models for a credential provider","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json get /realtime/models","href":"/api-reference/realtime/list-realtime-models-for-a-credential-provider"},{"title":"Get browser WebRTC configuration","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json get /realtime/config","href":"/api-reference/realtime/get-browser-webrtc-configuration"},{"title":"Start a realtime session from a WebRTC offer","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json post /realtime/sessions/{session_id}/offer","href":"/api-reference/realtime/start-a-realtime-session-from-a-webrtc-offer"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]},{"group":"embedding-model","pages":[{"title":"List all candidate embedding models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /embedding-model/","href":"/api-reference/embedding-model/list-all-candidate-embedding-models-under-the-given-credential-type"}]},{"group":"channels","pages":[{"title":"List Channel Types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/types","href":"/api-reference/channels/list-channel-types"},{"title":"List Channels","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/","href":"/api-reference/channels/list-channels"},{"title":"Create Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/","href":"/api-reference/channels/create-channel"},{"title":"Start Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings","href":"/api-reference/channels/start-credential-binding"},{"title":"Poll Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /channels/bindings/{binding_id}","href":"/api-reference/channels/poll-credential-binding"},{"title":"Cancel Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings/{binding_id}/cancel","href":"/api-reference/channels/cancel-credential-binding"},{"title":"Get Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-channel"},{"title":"Delete Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-channel"},{"title":"Update Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-channel"},{"title":"Enable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/enable","href":"/api-reference/channels/enable-channel"},{"title":"Disable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/disable","href":"/api-reference/channels/disable-channel"},{"title":"Channel Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/status","href":"/api-reference/channels/channel-status"},{"title":"List Channel Sessions","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/sessions","href":"/api-reference/channels/list-channel-sessions"},{"title":"List Chat Ids","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/chat_ids","href":"/api-reference/channels/list-chat-ids"}]}]}]},{"group":"Others","pages":[{"title":"FAQ","href":"/en/versions/2.0.10/others/faq"},{"title":"Changelog","href":"/en/versions/2.0.10/others/change-log"}]}]},{"version":"2.0.9","groups":[{"group":"Get Started","pages":[{"title":"What's AgentScope 2.0?","href":"/en/versions/2.0.9"},{"title":"Quickstart","href":"/en/versions/2.0.9/quickstart"},{"title":"Release Notes","href":"/en/versions/2.0.9/release-notes"}]},{"group":"Building Blocks","pages":[{"title":"Message \u0026 Event","href":"/en/versions/2.0.9/building-blocks/message-and-event"},{"group":"Agent","pages":[{"title":"Overview","href":"/en/versions/2.0.9/building-blocks/agent/overview"},{"title":"Configure Agent","href":"/en/versions/2.0.9/building-blocks/agent/configure-agent"},{"title":"Run Agent","href":"/en/versions/2.0.9/building-blocks/agent/run-agent"},{"title":"Interrupt Agent","href":"/en/versions/2.0.9/building-blocks/agent/interrupt-agent"},{"title":"Human-in-the-Loop","href":"/en/versions/2.0.9/building-blocks/agent/human-in-the-loop"}]},{"group":"Model","pages":[{"title":"Overview","href":"/en/versions/2.0.9/building-blocks/model/overview"},{"title":"LLM","href":"/en/versions/2.0.9/building-blocks/model/llm"},{"title":"TTS","href":"/en/versions/2.0.9/building-blocks/model/tts"},{"title":"Embedding","href":"/en/versions/2.0.9/building-blocks/model/embedding"}]},{"group":"Context","pages":[{"title":"Overview","href":"/en/versions/2.0.9/building-blocks/context/overview"},{"title":"Environment Awareness","href":"/en/versions/2.0.9/building-blocks/context/environment-awareness"},{"title":"Compress Context","href":"/en/versions/2.0.9/building-blocks/context/compress-context"},{"title":"Offload Context","href":"/en/versions/2.0.9/building-blocks/context/offload-context"}]},{"group":"Tool","pages":[{"title":"Overview","href":"/en/versions/2.0.9/building-blocks/tool/overview"},{"title":"Python Tool","href":"/en/versions/2.0.9/building-blocks/tool/python-tool"},{"title":"MCP","href":"/en/versions/2.0.9/building-blocks/tool/mcp"},{"title":"Skill","href":"/en/versions/2.0.9/building-blocks/tool/skill"},{"title":"Meta Tool","href":"/en/versions/2.0.9/building-blocks/tool/manage-tools"}]},{"title":"Plan","href":"/en/versions/2.0.9/building-blocks/plan"},{"group":"Pipeline","tag":"EXP","pages":[{"title":"Overview","href":"/en/versions/2.0.9/building-blocks/pipeline/overview"},{"title":"Goal Pipeline","href":"/en/versions/2.0.9/building-blocks/pipeline/goal"},{"title":"Team Pipeline","href":"/en/versions/2.0.9/building-blocks/pipeline/team"}]},{"title":"Standard Operating Procedure","tag":"EXP","href":"/en/versions/2.0.9/building-blocks/sop"},{"group":"Permission System","pages":[{"title":"Overview","href":"/en/versions/2.0.9/building-blocks/permission-system/overview"},{"title":"Permission Mode","href":"/en/versions/2.0.9/building-blocks/permission-system/permission-mode"},{"title":"Permission Rule","href":"/en/versions/2.0.9/building-blocks/permission-system/permission-rule"},{"title":"Tool-Level Checks","href":"/en/versions/2.0.9/building-blocks/permission-system/tool-check"}]},{"title":"Middleware","href":"/en/versions/2.0.9/building-blocks/middleware"},{"title":"RAG","href":"/en/versions/2.0.9/building-blocks/rag"},{"title":"Long-Term Memory","href":"/en/versions/2.0.9/building-blocks/long-term-memory"},{"group":"Workspace","pages":[{"title":"Overview","href":"/en/versions/2.0.9/building-blocks/workspace/overview"},{"title":"Run Workspace","href":"/en/versions/2.0.9/building-blocks/workspace/run-workspace"},{"title":"Manage Resources","href":"/en/versions/2.0.9/building-blocks/workspace/manage-resources"},{"title":"MCP Gateway","href":"/en/versions/2.0.9/building-blocks/workspace/mcp-gateway"}]},{"group":"Realtime Agent","tag":"EXP","pages":[{"title":"Overview","href":"/en/versions/2.0.9/building-blocks/realtime/overview"},{"title":"Speech-to-Speech","href":"/en/versions/2.0.9/building-blocks/realtime/speech-to-speech"}]},{"title":"Console","href":"/en/versions/2.0.9/building-blocks/console"},{"title":"A2A Protocol","href":"/en/versions/2.0.9/building-blocks/a2a"}]},{"group":"Agent as Service","pages":[{"title":"Architecture","href":"/en/versions/2.0.9/deploy/agent-service"},{"title":"Agent Team","href":"/en/versions/2.0.9/deploy/agent-team"},{"title":"SOP Service","tag":"EXP","href":"/en/versions/2.0.9/deploy/sop"},{"title":"Resource Sharing","tag":"NEW","href":"/en/versions/2.0.9/deploy/sharing"},{"title":"RAG Service","href":"/en/versions/2.0.9/deploy/rag"},{"title":"Workspace Manager","href":"/en/versions/2.0.9/deploy/workspace-manager"},{"group":"MCP \u0026 Skill Hub","pages":[{"title":"Overview","href":"/en/versions/2.0.9/deploy/hub/overview"},{"title":"MCP Hub","href":"/en/versions/2.0.9/deploy/hub/mcp-hub"},{"title":"Skill Hub","href":"/en/versions/2.0.9/deploy/hub/skill-hub"}]},{"group":"Channel","pages":[{"title":"Overview","href":"/en/versions/2.0.9/deploy/channel/overview"},{"title":"Message Routing","href":"/en/versions/2.0.9/deploy/channel/routing"},{"title":"Feishu","href":"/en/versions/2.0.9/deploy/channel/feishu"},{"title":"DingTalk","href":"/en/versions/2.0.9/deploy/channel/dingtalk"},{"title":"Discord","href":"/en/versions/2.0.9/deploy/channel/discord"},{"title":"Custom Channel","href":"/en/versions/2.0.9/deploy/channel/custom"}]},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"health","pages":[{"title":"Report service liveness and per-component readiness","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /health","href":"/api-reference/health/report-service-liveness-and-per-component-readiness"}]},{"group":"hub","pages":[{"title":"List Mcp Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp","href":"/api-reference/hub/list-mcp-hubs"},{"title":"List Mcp Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards","href":"/api-reference/hub/list-mcp-cards"},{"title":"Get Mcp Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-mcp-card"},{"title":"Install Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/mcp/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-mcp"},{"title":"List Skill Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill","href":"/api-reference/hub/list-skill-hubs"},{"title":"List Skill Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards","href":"/api-reference/hub/list-skill-cards"},{"title":"Install Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/skill/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-skill"},{"title":"Get Skill Card","description":"Return one skill card, including its ``SKILL.md`` body.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-skill-card"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"List available chunker types and their parameter schemas","description":"List every available chunker type with its parameter schema.\n\nThe front-end uses this to populate the chunker selector and\nto render a dynamic parameter form when creating a knowledge\nbase.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n chunker_classes (`list[type[ChunkerBase]]`):\n The chunker classes configured via\n ``create_app(knowledge_chunkers=...)``.\n\nReturns:\n `ListChunkersResponse`:\n All available chunker types with their JSON Schemas.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/chunkers","href":"/api-reference/knowledge_bases/list-available-chunker-types-and-their-parameter-schemas"},{"title":"JSON Schema for the KB middleware's tunable parameters","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Fetch the original uploaded file of a document","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/fetch-the-original-uploaded-file-of-a-document"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"},{"title":"Browse one document's chunks in order","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}/chunks","href":"/api-reference/knowledge_bases/browse-one-documents-chunks-in-order"},{"title":"Mint a short-lived token for a browser-native fetch","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents/{document_id}/download_token","href":"/api-reference/knowledge_bases/mint-a-short-lived-token-for-a-browser-native-fetch"}]},{"group":"mcp","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /mcp","href":"/api-reference/mcp/list-mcps"},{"title":"Delete Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /mcp/{mcp_id}","href":"/api-reference/mcp/delete-mcp"},{"title":"Update Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /mcp/{mcp_id}","href":"/api-reference/mcp/update-mcp"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"skill","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill","href":"/api-reference/skill/list-skills"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill/{skill_id}","href":"/api-reference/skill/get-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /skill/{skill_id}","href":"/api-reference/skill/delete-skill"}]},{"group":"sop","pages":[{"title":"The schema a procedure's editor is built from","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/schema","href":"/api-reference/sop/the-schema-a-procedures-editor-is-built-from"},{"title":"List procedures","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/","href":"/api-reference/sop/list-procedures"},{"title":"Create a procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/","href":"/api-reference/sop/create-a-procedure"},{"title":"List runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs","href":"/api-reference/sop/list-runs"},{"title":"Read one run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs/{sop_run_id}","href":"/api-reference/sop/read-one-run"},{"title":"Delete a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/runs/{sop_run_id}","href":"/api-reference/sop/delete-a-run"},{"title":"File a person's verdict on a step","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/runs/{sop_run_id}/verdict","href":"/api-reference/sop/file-a-persons-verdict-on-a-step"},{"title":"Read one procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/{sop_id}","href":"/api-reference/sop/read-one-procedure"},{"title":"Delete a procedure and its runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/{sop_id}","href":"/api-reference/sop/delete-a-procedure-and-its-runs"},{"title":"Replace a procedure's contents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json patch /sop/{sop_id}","href":"/api-reference/sop/replace-a-procedures-contents"},{"title":"Start a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/{sop_id}/runs","href":"/api-reference/sop/start-a-run"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Add Mcps From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/mcp/from-library","href":"/api-reference/workspace/add-mcps-from-library"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Upload Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/upload","href":"/api-reference/workspace/upload-skill"},{"title":"Add Skills From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/from-library","href":"/api-reference/workspace/add-skills-from-library"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"},{"title":"List Workspace Directory","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/directories","href":"/api-reference/workspace/list-workspace-directory"},{"title":"Get Workspace Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /workspace/status","href":"/api-reference/workspace/get-workspace-status"},{"title":"Create Download Token","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/files/download-token","href":"/api-reference/workspace/create-download-token"},{"title":"Read Workspace File","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/files","href":"/api-reference/workspace/read-workspace-file"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]},{"group":"embedding-model","pages":[{"title":"List all candidate embedding models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /embedding-model/","href":"/api-reference/embedding-model/list-all-candidate-embedding-models-under-the-given-credential-type"}]},{"group":"channels","pages":[{"title":"List Channel Types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/types","href":"/api-reference/channels/list-channel-types"},{"title":"List Channels","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/","href":"/api-reference/channels/list-channels"},{"title":"Create Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/","href":"/api-reference/channels/create-channel"},{"title":"Start Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings","href":"/api-reference/channels/start-credential-binding"},{"title":"Poll Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /channels/bindings/{binding_id}","href":"/api-reference/channels/poll-credential-binding"},{"title":"Cancel Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings/{binding_id}/cancel","href":"/api-reference/channels/cancel-credential-binding"},{"title":"Get Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-channel"},{"title":"Delete Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-channel"},{"title":"Update Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-channel"},{"title":"Enable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/enable","href":"/api-reference/channels/enable-channel"},{"title":"Disable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/disable","href":"/api-reference/channels/disable-channel"},{"title":"Channel Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/status","href":"/api-reference/channels/channel-status"},{"title":"List Channel Sessions","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/sessions","href":"/api-reference/channels/list-channel-sessions"},{"title":"List Chat Ids","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/chat_ids","href":"/api-reference/channels/list-chat-ids"}]}]}]},{"group":"Others","pages":[{"title":"FAQ","href":"/en/versions/2.0.9/others/faq"},{"title":"Changelog","href":"/en/versions/2.0.9/others/change-log"}]}]},{"version":"2.0.8","groups":[{"group":"Get Started","pages":[{"title":"What's AgentScope 2.0?","href":"/en/versions/2.0.8"},{"title":"Quickstart","href":"/en/versions/2.0.8/quickstart"},{"title":"Release Notes","href":"/en/versions/2.0.8/release-notes"}]},{"group":"Building Blocks","pages":[{"title":"Message \u0026 Event","href":"/en/versions/2.0.8/building-blocks/message-and-event"},{"group":"Agent","pages":[{"title":"Overview","href":"/en/versions/2.0.8/building-blocks/agent/overview"},{"title":"Configure Agent","href":"/en/versions/2.0.8/building-blocks/agent/configure-agent"},{"title":"Run Agent","href":"/en/versions/2.0.8/building-blocks/agent/run-agent"},{"title":"Interrupt Agent","href":"/en/versions/2.0.8/building-blocks/agent/interrupt-agent"},{"title":"Human-in-the-Loop","href":"/en/versions/2.0.8/building-blocks/agent/human-in-the-loop"}]},{"group":"Model","pages":[{"title":"Overview","href":"/en/versions/2.0.8/building-blocks/model/overview"},{"title":"LLM","href":"/en/versions/2.0.8/building-blocks/model/llm"},{"title":"TTS","href":"/en/versions/2.0.8/building-blocks/model/tts"},{"title":"Embedding","href":"/en/versions/2.0.8/building-blocks/model/embedding"}]},{"group":"Context","pages":[{"title":"Overview","href":"/en/versions/2.0.8/building-blocks/context/overview"},{"title":"Environment Awareness","href":"/en/versions/2.0.8/building-blocks/context/environment-awareness"},{"title":"Compress Context","href":"/en/versions/2.0.8/building-blocks/context/compress-context"},{"title":"Offload Context","href":"/en/versions/2.0.8/building-blocks/context/offload-context"}]},{"group":"Tool","pages":[{"title":"Overview","href":"/en/versions/2.0.8/building-blocks/tool/overview"},{"title":"Python Tool","href":"/en/versions/2.0.8/building-blocks/tool/python-tool"},{"title":"MCP","href":"/en/versions/2.0.8/building-blocks/tool/mcp"},{"title":"Skill","href":"/en/versions/2.0.8/building-blocks/tool/skill"},{"title":"Meta Tool","href":"/en/versions/2.0.8/building-blocks/tool/manage-tools"}]},{"title":"Plan","href":"/en/versions/2.0.8/building-blocks/plan"},{"group":"Pipeline","tag":"EXP","pages":[{"title":"Overview","href":"/en/versions/2.0.8/building-blocks/pipeline/overview"},{"title":"Goal Pipeline","href":"/en/versions/2.0.8/building-blocks/pipeline/goal"}]},{"group":"Permission System","pages":[{"title":"Overview","href":"/en/versions/2.0.8/building-blocks/permission-system/overview"},{"title":"Permission Mode","href":"/en/versions/2.0.8/building-blocks/permission-system/permission-mode"},{"title":"Permission Rule","href":"/en/versions/2.0.8/building-blocks/permission-system/permission-rule"},{"title":"Tool-Level Checks","href":"/en/versions/2.0.8/building-blocks/permission-system/tool-check"}]},{"title":"Middleware","href":"/en/versions/2.0.8/building-blocks/middleware"},{"title":"RAG","href":"/en/versions/2.0.8/building-blocks/rag"},{"title":"Long-Term Memory","href":"/en/versions/2.0.8/building-blocks/long-term-memory"},{"group":"Workspace","pages":[{"title":"Overview","href":"/en/versions/2.0.8/building-blocks/workspace/overview"},{"title":"Run Workspace","href":"/en/versions/2.0.8/building-blocks/workspace/run-workspace"},{"title":"Manage Resources","href":"/en/versions/2.0.8/building-blocks/workspace/manage-resources"},{"title":"MCP Gateway","href":"/en/versions/2.0.8/building-blocks/workspace/mcp-gateway"}]},{"group":"Realtime Agent","tag":"EXP","pages":[{"title":"Overview","href":"/en/versions/2.0.8/building-blocks/realtime/overview"},{"title":"Speech-to-Speech","href":"/en/versions/2.0.8/building-blocks/realtime/speech-to-speech"}]},{"title":"Console","href":"/en/versions/2.0.8/building-blocks/console"},{"title":"A2A Protocol","href":"/en/versions/2.0.8/building-blocks/a2a"}]},{"group":"Agent as Service","pages":[{"title":"Architecture","href":"/en/versions/2.0.8/deploy/agent-service"},{"title":"Agent Team","href":"/en/versions/2.0.8/deploy/agent-team"},{"title":"Resource Sharing","tag":"NEW","href":"/en/versions/2.0.8/deploy/sharing"},{"title":"RAG Service","href":"/en/versions/2.0.8/deploy/rag"},{"title":"Workspace Manager","href":"/en/versions/2.0.8/deploy/workspace-manager"},{"group":"MCP \u0026 Skill Hub","pages":[{"title":"Overview","href":"/en/versions/2.0.8/deploy/hub/overview"},{"title":"MCP Hub","href":"/en/versions/2.0.8/deploy/hub/mcp-hub"},{"title":"Skill Hub","href":"/en/versions/2.0.8/deploy/hub/skill-hub"}]},{"group":"Channel","pages":[{"title":"Overview","href":"/en/versions/2.0.8/deploy/channel/overview"},{"title":"Message Routing","href":"/en/versions/2.0.8/deploy/channel/routing"},{"title":"Feishu","href":"/en/versions/2.0.8/deploy/channel/feishu"},{"title":"DingTalk","href":"/en/versions/2.0.8/deploy/channel/dingtalk"},{"title":"Discord","href":"/en/versions/2.0.8/deploy/channel/discord"},{"title":"Custom Channel","href":"/en/versions/2.0.8/deploy/channel/custom"}]},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"health","pages":[{"title":"Report service liveness and per-component readiness","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /health","href":"/api-reference/health/report-service-liveness-and-per-component-readiness"}]},{"group":"hub","pages":[{"title":"List Mcp Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp","href":"/api-reference/hub/list-mcp-hubs"},{"title":"List Mcp Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards","href":"/api-reference/hub/list-mcp-cards"},{"title":"Get Mcp Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-mcp-card"},{"title":"Install Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/mcp/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-mcp"},{"title":"List Skill Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill","href":"/api-reference/hub/list-skill-hubs"},{"title":"List Skill Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards","href":"/api-reference/hub/list-skill-cards"},{"title":"Get Skill Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-skill-card"},{"title":"Install Skill","description":"Add a skill card to the user's library.\n\nMirrors the MCP install: user-level, no workspace involved. The\narchive is not downloaded here — only the card's metadata is\nrecorded, and the files are fetched when the skill is actually put\ninto a workspace. So a hub that has since dropped the card fails\nthen rather than now.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/skill/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-skill"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"JSON Schema for the KB middleware's tunable parameters","description":"Return the parameter schema for\n:class:`agentscope.middleware.RAGMiddleware`.\n\nThe schema is shaped like every other ``parameter_schema`` served\nby this service — title / description / default / enum / minimum\n/ maximum — so the front-end can render the session-level KB\nattachment form with the same schema-driven component used for\nmodel parameters.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n\nReturns:\n `KbMiddlewareParametersSchemaResponse`:\n The JSON Schema describing the middleware's\n user-tunable parameters.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"}]},{"group":"mcp","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /mcp","href":"/api-reference/mcp/list-mcps"},{"title":"Delete Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /mcp/{mcp_id}","href":"/api-reference/mcp/delete-mcp"},{"title":"Update Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /mcp/{mcp_id}","href":"/api-reference/mcp/update-mcp"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"skill","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill","href":"/api-reference/skill/list-skills"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill/{skill_id}","href":"/api-reference/skill/get-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /skill/{skill_id}","href":"/api-reference/skill/delete-skill"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Add Mcps From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/mcp/from-library","href":"/api-reference/workspace/add-mcps-from-library"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Upload Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/upload","href":"/api-reference/workspace/upload-skill"},{"title":"Add Skills From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/from-library","href":"/api-reference/workspace/add-skills-from-library"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"},{"title":"List Workspace Directory","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/directories","href":"/api-reference/workspace/list-workspace-directory"},{"title":"Create Download Token","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/files/download-token","href":"/api-reference/workspace/create-download-token"},{"title":"Read Workspace File","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/files","href":"/api-reference/workspace/read-workspace-file"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]},{"group":"embedding-model","pages":[{"title":"List all candidate embedding models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /embedding-model/","href":"/api-reference/embedding-model/list-all-candidate-embedding-models-under-the-given-credential-type"}]},{"group":"channels","pages":[{"title":"List Channel Types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/types","href":"/api-reference/channels/list-channel-types"},{"title":"List Channels","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/","href":"/api-reference/channels/list-channels"},{"title":"Create Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/","href":"/api-reference/channels/create-channel"},{"title":"Get Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-channel"},{"title":"Delete Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-channel"},{"title":"Update Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-channel"},{"title":"Enable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/enable","href":"/api-reference/channels/enable-channel"},{"title":"Disable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/disable","href":"/api-reference/channels/disable-channel"},{"title":"Channel Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/status","href":"/api-reference/channels/channel-status"},{"title":"List Channel Sessions","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/sessions","href":"/api-reference/channels/list-channel-sessions"},{"title":"List Chat Ids","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/chat_ids","href":"/api-reference/channels/list-chat-ids"}]}]}]},{"group":"Others","pages":[{"title":"FAQ","href":"/en/versions/2.0.8/others/faq"},{"title":"Changelog","href":"/en/versions/2.0.8/others/change-log"}]}]},{"version":"2.0.7","groups":[{"group":"Get Started","pages":[{"title":"What's AgentScope 2.0?","href":"/en/versions/2.0.7"},{"title":"Quickstart","href":"/en/versions/2.0.7/quickstart"},{"title":"Release Notes","href":"/en/versions/2.0.7/release-notes"}]},{"group":"Building Blocks","pages":[{"title":"Message \u0026 Event","href":"/en/versions/2.0.7/building-blocks/message-and-event"},{"group":"Agent","pages":[{"title":"Overview","href":"/en/versions/2.0.7/building-blocks/agent/overview"},{"title":"Configure Agent","href":"/en/versions/2.0.7/building-blocks/agent/configure-agent"},{"title":"Run Agent","href":"/en/versions/2.0.7/building-blocks/agent/run-agent"},{"title":"Interrupt Agent","href":"/en/versions/2.0.7/building-blocks/agent/interrupt-agent"},{"title":"Human-in-the-Loop","href":"/en/versions/2.0.7/building-blocks/agent/human-in-the-loop"}]},{"group":"Model","pages":[{"title":"Overview","href":"/en/versions/2.0.7/building-blocks/model/overview"},{"title":"LLM","href":"/en/versions/2.0.7/building-blocks/model/llm"},{"title":"TTS","href":"/en/versions/2.0.7/building-blocks/model/tts"},{"title":"Embedding","href":"/en/versions/2.0.7/building-blocks/model/embedding"}]},{"group":"Context","pages":[{"title":"Overview","href":"/en/versions/2.0.7/building-blocks/context/overview"},{"title":"Environment Awareness","href":"/en/versions/2.0.7/building-blocks/context/environment-awareness"},{"title":"Compress Context","href":"/en/versions/2.0.7/building-blocks/context/compress-context"},{"title":"Offload Context","href":"/en/versions/2.0.7/building-blocks/context/offload-context"}]},{"group":"Tool","pages":[{"title":"Overview","href":"/en/versions/2.0.7/building-blocks/tool/overview"},{"title":"Python Tool","href":"/en/versions/2.0.7/building-blocks/tool/python-tool"},{"title":"MCP","href":"/en/versions/2.0.7/building-blocks/tool/mcp"},{"title":"Skill","href":"/en/versions/2.0.7/building-blocks/tool/skill"},{"title":"Meta Tool","href":"/en/versions/2.0.7/building-blocks/tool/manage-tools"}]},{"title":"Plan","href":"/en/versions/2.0.7/building-blocks/plan"},{"group":"Permission System","pages":[{"title":"Overview","href":"/en/versions/2.0.7/building-blocks/permission-system/overview"},{"title":"Permission Mode","href":"/en/versions/2.0.7/building-blocks/permission-system/permission-mode"},{"title":"Permission Rule","href":"/en/versions/2.0.7/building-blocks/permission-system/permission-rule"},{"title":"Tool-Level Checks","href":"/en/versions/2.0.7/building-blocks/permission-system/tool-check"}]},{"title":"Middleware","href":"/en/versions/2.0.7/building-blocks/middleware"},{"title":"RAG","href":"/en/versions/2.0.7/building-blocks/rag"},{"title":"Long-Term Memory","href":"/en/versions/2.0.7/building-blocks/long-term-memory"},{"group":"Workspace","pages":[{"title":"Overview","href":"/en/versions/2.0.7/building-blocks/workspace/overview"},{"title":"Run Workspace","href":"/en/versions/2.0.7/building-blocks/workspace/run-workspace"},{"title":"Manage Resources","href":"/en/versions/2.0.7/building-blocks/workspace/manage-resources"},{"title":"MCP Gateway","href":"/en/versions/2.0.7/building-blocks/workspace/mcp-gateway"}]},{"title":"Console","href":"/en/versions/2.0.7/building-blocks/console"}]},{"group":"Agent as Service","pages":[{"title":"Architecture","href":"/en/versions/2.0.7/deploy/agent-service"},{"title":"Agent Team","href":"/en/versions/2.0.7/deploy/agent-team"},{"title":"Resource Sharing","tag":"NEW","href":"/en/versions/2.0.7/deploy/sharing"},{"title":"RAG Service","href":"/en/versions/2.0.7/deploy/rag"},{"title":"Workspace Manager","href":"/en/versions/2.0.7/deploy/workspace-manager"},{"group":"MCP \u0026 Skill Hub","tag":"NEW","pages":[{"title":"Overview","href":"/en/versions/2.0.7/deploy/hub/overview"},{"title":"MCP Hub","href":"/en/versions/2.0.7/deploy/hub/mcp-hub"},{"title":"Skill Hub","href":"/en/versions/2.0.7/deploy/hub/skill-hub"}]},{"group":"Channel","tag":"NEW","pages":[{"title":"Overview","href":"/en/versions/2.0.7/deploy/channel/overview"},{"title":"Message Routing","href":"/en/versions/2.0.7/deploy/channel/routing"},{"title":"Feishu","href":"/en/versions/2.0.7/deploy/channel/feishu"},{"title":"DingTalk","href":"/en/versions/2.0.7/deploy/channel/dingtalk"},{"title":"Discord","href":"/en/versions/2.0.7/deploy/channel/discord"},{"title":"Custom Channel","href":"/en/versions/2.0.7/deploy/channel/custom"}]},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"health","pages":[{"title":"Report service liveness and per-component readiness","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /health","href":"/api-reference/health/report-service-liveness-and-per-component-readiness"}]},{"group":"hub","pages":[{"title":"List Mcp Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp","href":"/api-reference/hub/list-mcp-hubs"},{"title":"List Mcp Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards","href":"/api-reference/hub/list-mcp-cards"},{"title":"Get Mcp Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-mcp-card"},{"title":"Install Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/mcp/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-mcp"},{"title":"List Skill Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill","href":"/api-reference/hub/list-skill-hubs"},{"title":"List Skill Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards","href":"/api-reference/hub/list-skill-cards"},{"title":"Get Skill Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-skill-card"},{"title":"Install Skill","description":"Add a skill card to the user's library.\n\nMirrors the MCP install: user-level, no workspace involved. The\narchive is not downloaded here — only the card's metadata is\nrecorded, and the files are fetched when the skill is actually put\ninto a workspace. So a hub that has since dropped the card fails\nthen rather than now.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/skill/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-skill"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"JSON Schema for the KB middleware's tunable parameters","description":"Return the parameter schema for\n:class:`agentscope.middleware.RAGMiddleware`.\n\nThe schema is shaped like every other ``parameter_schema`` served\nby this service — title / description / default / enum / minimum\n/ maximum — so the front-end can render the session-level KB\nattachment form with the same schema-driven component used for\nmodel parameters.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n\nReturns:\n `KbMiddlewareParametersSchemaResponse`:\n The JSON Schema describing the middleware's\n user-tunable parameters.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"}]},{"group":"mcp","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /mcp","href":"/api-reference/mcp/list-mcps"},{"title":"Delete Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /mcp/{mcp_id}","href":"/api-reference/mcp/delete-mcp"},{"title":"Update Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /mcp/{mcp_id}","href":"/api-reference/mcp/update-mcp"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"skill","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill","href":"/api-reference/skill/list-skills"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill/{skill_id}","href":"/api-reference/skill/get-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /skill/{skill_id}","href":"/api-reference/skill/delete-skill"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Add Mcps From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/mcp/from-library","href":"/api-reference/workspace/add-mcps-from-library"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Upload Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/upload","href":"/api-reference/workspace/upload-skill"},{"title":"Add Skills From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/from-library","href":"/api-reference/workspace/add-skills-from-library"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"},{"title":"List Workspace Directory","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/directories","href":"/api-reference/workspace/list-workspace-directory"},{"title":"Create Download Token","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/files/download-token","href":"/api-reference/workspace/create-download-token"},{"title":"Read Workspace File","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/files","href":"/api-reference/workspace/read-workspace-file"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]},{"group":"embedding-model","pages":[{"title":"List all candidate embedding models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /embedding-model/","href":"/api-reference/embedding-model/list-all-candidate-embedding-models-under-the-given-credential-type"}]},{"group":"channels","pages":[{"title":"List Channel Types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/types","href":"/api-reference/channels/list-channel-types"},{"title":"List Channels","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/","href":"/api-reference/channels/list-channels"},{"title":"Create Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/","href":"/api-reference/channels/create-channel"},{"title":"Get Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-channel"},{"title":"Delete Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-channel"},{"title":"Update Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-channel"},{"title":"Enable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/enable","href":"/api-reference/channels/enable-channel"},{"title":"Disable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/disable","href":"/api-reference/channels/disable-channel"},{"title":"Channel Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/status","href":"/api-reference/channels/channel-status"},{"title":"List Channel Sessions","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/sessions","href":"/api-reference/channels/list-channel-sessions"},{"title":"List Chat Ids","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/chat_ids","href":"/api-reference/channels/list-chat-ids"}]}]}]},{"group":"Others","pages":[{"title":"FAQ","href":"/en/versions/2.0.7/others/faq"},{"title":"Changelog","href":"/en/versions/2.0.7/others/change-log"}]}]},{"version":"2.0.6","groups":[{"group":"Get Started","pages":[{"title":"What's AgentScope 2.0?","href":"/en/versions/2.0.6"},{"title":"Quickstart","href":"/en/versions/2.0.6/quickstart"},{"title":"Release Notes","href":"/en/versions/2.0.6/release-notes"}]},{"group":"Building Blocks","pages":[{"title":"Message \u0026 Event","href":"/en/versions/2.0.6/building-blocks/message-and-event"},{"group":"Agent","pages":[{"title":"Overview","href":"/en/versions/2.0.6/building-blocks/agent/overview"},{"title":"Configure Agent","href":"/en/versions/2.0.6/building-blocks/agent/configure-agent"},{"title":"Run Agent","href":"/en/versions/2.0.6/building-blocks/agent/run-agent"},{"title":"Interrupt Agent","href":"/en/versions/2.0.6/building-blocks/agent/interrupt-agent"},{"title":"Human-in-the-Loop","href":"/en/versions/2.0.6/building-blocks/agent/human-in-the-loop"}]},{"group":"Model","pages":[{"title":"Overview","href":"/en/versions/2.0.6/building-blocks/model/overview"},{"title":"LLM","href":"/en/versions/2.0.6/building-blocks/model/llm"},{"title":"TTS","href":"/en/versions/2.0.6/building-blocks/model/tts"},{"title":"Embedding","href":"/en/versions/2.0.6/building-blocks/model/embedding"}]},{"group":"Context","pages":[{"title":"Overview","href":"/en/versions/2.0.6/building-blocks/context/overview"},{"title":"Environment Awareness","href":"/en/versions/2.0.6/building-blocks/context/environment-awareness"},{"title":"Compress Context","href":"/en/versions/2.0.6/building-blocks/context/compress-context"},{"title":"Offload Context","href":"/en/versions/2.0.6/building-blocks/context/offload-context"}]},{"group":"Tool","pages":[{"title":"Overview","href":"/en/versions/2.0.6/building-blocks/tool/overview"},{"title":"Python Tool","href":"/en/versions/2.0.6/building-blocks/tool/python-tool"},{"title":"MCP","href":"/en/versions/2.0.6/building-blocks/tool/mcp"},{"title":"Skill","href":"/en/versions/2.0.6/building-blocks/tool/skill"},{"title":"Meta Tool","href":"/en/versions/2.0.6/building-blocks/tool/manage-tools"}]},{"title":"Plan","href":"/en/versions/2.0.6/building-blocks/plan"},{"group":"Permission System","pages":[{"title":"Overview","href":"/en/versions/2.0.6/building-blocks/permission-system/overview"},{"title":"Permission Mode","href":"/en/versions/2.0.6/building-blocks/permission-system/permission-mode"},{"title":"Permission Rule","href":"/en/versions/2.0.6/building-blocks/permission-system/permission-rule"},{"title":"Tool-Level Checks","href":"/en/versions/2.0.6/building-blocks/permission-system/tool-check"}]},{"title":"Middleware","href":"/en/versions/2.0.6/building-blocks/middleware"},{"title":"RAG","href":"/en/versions/2.0.6/building-blocks/rag"},{"title":"Long-Term Memory","href":"/en/versions/2.0.6/building-blocks/long-term-memory"},{"group":"Workspace","pages":[{"title":"Overview","href":"/en/versions/2.0.6/building-blocks/workspace/overview"},{"title":"Run Workspace","href":"/en/versions/2.0.6/building-blocks/workspace/run-workspace"},{"title":"Manage Resources","href":"/en/versions/2.0.6/building-blocks/workspace/manage-resources"},{"title":"MCP Gateway","href":"/en/versions/2.0.6/building-blocks/workspace/mcp-gateway"}]}]},{"group":"Agent as Service","pages":[{"title":"Architecture","href":"/en/versions/2.0.6/deploy/agent-service"},{"title":"Agent Team","href":"/en/versions/2.0.6/deploy/agent-team"},{"title":"Resource Sharing","tag":"NEW","href":"/en/versions/2.0.6/deploy/sharing"},{"title":"RAG Service","href":"/en/versions/2.0.6/deploy/rag"},{"title":"Workspace Manager","href":"/en/versions/2.0.6/deploy/workspace-manager"},{"group":"MCP \u0026 Skill Hub","tag":"NEW","pages":[{"title":"Overview","href":"/en/versions/2.0.6/deploy/hub/overview"},{"title":"MCP Hub","href":"/en/versions/2.0.6/deploy/hub/mcp-hub"},{"title":"Skill Hub","href":"/en/versions/2.0.6/deploy/hub/skill-hub"}]},{"group":"Channel","tag":"NEW","pages":[{"title":"Overview","href":"/en/versions/2.0.6/deploy/channel/overview"},{"title":"Message routing","href":"/en/versions/2.0.6/deploy/channel/routing"},{"title":"Feishu","href":"/en/versions/2.0.6/deploy/channel/feishu"},{"title":"Discord","href":"/en/versions/2.0.6/deploy/channel/discord"},{"title":"Custom channel","href":"/en/versions/2.0.6/deploy/channel/custom"}]},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"health","pages":[{"title":"Report service liveness and per-component readiness","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /health","href":"/api-reference/health/report-service-liveness-and-per-component-readiness"}]},{"group":"hub","pages":[{"title":"List Mcp Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp","href":"/api-reference/hub/list-mcp-hubs"},{"title":"List Mcp Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards","href":"/api-reference/hub/list-mcp-cards"},{"title":"Get Mcp Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-mcp-card"},{"title":"Install Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/mcp/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-mcp"},{"title":"List Skill Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill","href":"/api-reference/hub/list-skill-hubs"},{"title":"List Skill Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards","href":"/api-reference/hub/list-skill-cards"},{"title":"Get Skill Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-skill-card"},{"title":"Install Skill","description":"Add a skill card to the user's library.\n\nMirrors the MCP install: user-level, no workspace involved. The\narchive is not downloaded here — only the card's metadata is\nrecorded, and the files are fetched when the skill is actually put\ninto a workspace. So a hub that has since dropped the card fails\nthen rather than now.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/skill/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-skill"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"JSON Schema for the KB middleware's tunable parameters","description":"Return the parameter schema for\n:class:`agentscope.middleware.RAGMiddleware`.\n\nThe schema is shaped like every other ``parameter_schema`` served\nby this service — title / description / default / enum / minimum\n/ maximum — so the front-end can render the session-level KB\nattachment form with the same schema-driven component used for\nmodel parameters.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n\nReturns:\n `KbMiddlewareParametersSchemaResponse`:\n The JSON Schema describing the middleware's\n user-tunable parameters.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"}]},{"group":"mcp","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /mcp","href":"/api-reference/mcp/list-mcps"},{"title":"Delete Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /mcp/{mcp_id}","href":"/api-reference/mcp/delete-mcp"},{"title":"Update Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /mcp/{mcp_id}","href":"/api-reference/mcp/update-mcp"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"skill","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill","href":"/api-reference/skill/list-skills"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill/{skill_id}","href":"/api-reference/skill/get-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /skill/{skill_id}","href":"/api-reference/skill/delete-skill"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Add Mcps From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/mcp/from-library","href":"/api-reference/workspace/add-mcps-from-library"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Upload Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/upload","href":"/api-reference/workspace/upload-skill"},{"title":"Add Skills From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/from-library","href":"/api-reference/workspace/add-skills-from-library"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"},{"title":"List Workspace Directory","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/directories","href":"/api-reference/workspace/list-workspace-directory"},{"title":"Create Download Token","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/files/download-token","href":"/api-reference/workspace/create-download-token"},{"title":"Read Workspace File","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/files","href":"/api-reference/workspace/read-workspace-file"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]},{"group":"embedding-model","pages":[{"title":"List all candidate embedding models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /embedding-model/","href":"/api-reference/embedding-model/list-all-candidate-embedding-models-under-the-given-credential-type"}]},{"group":"channels","pages":[{"title":"List Channel Types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/types","href":"/api-reference/channels/list-channel-types"},{"title":"List Channels","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/","href":"/api-reference/channels/list-channels"},{"title":"Create Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/","href":"/api-reference/channels/create-channel"},{"title":"Get Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-channel"},{"title":"Delete Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-channel"},{"title":"Update Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-channel"},{"title":"Enable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/enable","href":"/api-reference/channels/enable-channel"},{"title":"Disable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/disable","href":"/api-reference/channels/disable-channel"},{"title":"Channel Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/status","href":"/api-reference/channels/channel-status"},{"title":"List Channel Sessions","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/sessions","href":"/api-reference/channels/list-channel-sessions"},{"title":"List Chat Ids","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/chat_ids","href":"/api-reference/channels/list-chat-ids"}]}]}]},{"group":"Others","pages":[{"title":"FAQ","href":"/en/versions/2.0.6/others/faq"},{"title":"Changelog","href":"/en/versions/2.0.6/others/change-log"}]}]},{"version":"2.0.5","groups":[{"group":"Get Started","pages":[{"title":"What's AgentScope 2.0?","href":"/en/versions/2.0.5"},{"title":"Quickstart","href":"/en/versions/2.0.5/quickstart"},{"title":"Release Notes","href":"/en/versions/2.0.5/release-notes"}]},{"group":"Building Blocks","pages":[{"title":"Message \u0026 Event","href":"/en/versions/2.0.5/building-blocks/message-and-event"},{"group":"Agent","pages":[{"title":"Overview","href":"/en/versions/2.0.5/building-blocks/agent/overview"},{"title":"Configure Agent","href":"/en/versions/2.0.5/building-blocks/agent/configure-agent"},{"title":"Run Agent","href":"/en/versions/2.0.5/building-blocks/agent/run-agent"},{"title":"Interrupt Agent","href":"/en/versions/2.0.5/building-blocks/agent/interrupt-agent"},{"title":"Human-in-the-Loop","href":"/en/versions/2.0.5/building-blocks/agent/human-in-the-loop"}]},{"group":"Model","pages":[{"title":"Overview","href":"/en/versions/2.0.5/building-blocks/model/overview"},{"title":"LLM","href":"/en/versions/2.0.5/building-blocks/model/llm"},{"title":"TTS","href":"/en/versions/2.0.5/building-blocks/model/tts"},{"title":"Embedding","href":"/en/versions/2.0.5/building-blocks/model/embedding"}]},{"group":"Context","pages":[{"title":"Overview","href":"/en/versions/2.0.5/building-blocks/context/overview"},{"title":"Environment Awareness","href":"/en/versions/2.0.5/building-blocks/context/environment-awareness"},{"title":"Compress Context","href":"/en/versions/2.0.5/building-blocks/context/compress-context"},{"title":"Offload Context","href":"/en/versions/2.0.5/building-blocks/context/offload-context"}]},{"group":"Tool","pages":[{"title":"Overview","href":"/en/versions/2.0.5/building-blocks/tool/overview"},{"title":"Python Tool","href":"/en/versions/2.0.5/building-blocks/tool/python-tool"},{"title":"MCP","href":"/en/versions/2.0.5/building-blocks/tool/mcp"},{"title":"Skill","href":"/en/versions/2.0.5/building-blocks/tool/skill"},{"title":"Meta Tool","href":"/en/versions/2.0.5/building-blocks/tool/manage-tools"}]},{"title":"Plan","href":"/en/versions/2.0.5/building-blocks/plan"},{"group":"Permission System","pages":[{"title":"Overview","href":"/en/versions/2.0.5/building-blocks/permission-system/overview"},{"title":"Permission Mode","href":"/en/versions/2.0.5/building-blocks/permission-system/permission-mode"},{"title":"Permission Rule","href":"/en/versions/2.0.5/building-blocks/permission-system/permission-rule"},{"title":"Tool-Level Checks","href":"/en/versions/2.0.5/building-blocks/permission-system/tool-check"}]},{"title":"Middleware","href":"/en/versions/2.0.5/building-blocks/middleware"},{"title":"RAG","href":"/en/versions/2.0.5/building-blocks/rag"},{"title":"Long-Term Memory","href":"/en/versions/2.0.5/building-blocks/long-term-memory"},{"group":"Workspace","pages":[{"title":"Overview","href":"/en/versions/2.0.5/building-blocks/workspace/overview"},{"title":"Run Workspace","href":"/en/versions/2.0.5/building-blocks/workspace/run-workspace"},{"title":"Manage Resources","href":"/en/versions/2.0.5/building-blocks/workspace/manage-resources"},{"title":"MCP Gateway","href":"/en/versions/2.0.5/building-blocks/workspace/mcp-gateway"}]}]},{"group":"Agent as Service","pages":[{"title":"Architecture","href":"/en/versions/2.0.5/deploy/agent-service"},{"title":"Agent Team","href":"/en/versions/2.0.5/deploy/agent-team"},{"title":"Resource Sharing","tag":"NEW","href":"/en/versions/2.0.5/deploy/sharing"},{"title":"RAG Service","href":"/en/versions/2.0.5/deploy/rag"},{"title":"Workspace Manager","tag":"NEW","href":"/en/versions/2.0.5/deploy/workspace-manager"},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","description":"Replace the payload of an existing credential.\n\nArgs:\n credential_id (`str`): The credential to update.\n body (`UpdateCredentialRequest`): New credential payload.\n user_id (`str`): Injected authenticated user ID.\n storage (`StorageBase`): Injected storage backend.\n\nReturns:\n `CredentialRecord`: The updated credential record.\n\nRaises:\n `HTTPException`: 404 if the credential does not exist or does not\n belong to the authenticated user.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"JSON Schema for the KB middleware's tunable parameters","description":"Return the parameter schema for\n:class:`agentscope.middleware.RAGMiddleware`.\n\nThe schema is shaped like every other ``parameter_schema`` served\nby this service — title / description / default / enum / minimum\n/ maximum — so the front-end can render the session-level KB\nattachment form with the same schema-driven component used for\nmodel parameters.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n\nReturns:\n `KbMiddlewareParametersSchemaResponse`:\n The JSON Schema describing the middleware's\n user-tunable parameters.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]}]}]},{"group":"Others","pages":[{"title":"FAQ","href":"/en/versions/2.0.5/others/faq"},{"title":"Changelog","href":"/en/versions/2.0.5/others/change-log"}]}]},{"version":"2.0.4","groups":[{"group":"Get Started","pages":[{"title":"What's AgentScope 2.0?","href":"/en/versions/2.0.4"},{"title":"Quickstart","href":"/en/versions/2.0.4/quickstart"},{"title":"Release Notes","href":"/en/versions/2.0.4/release-notes"}]},{"group":"Building Blocks","pages":[{"title":"Message \u0026 Event","href":"/en/versions/2.0.4/building-blocks/message-and-event"},{"title":"Agent","href":"/en/versions/2.0.4/building-blocks/agent"},{"title":"Model","href":"/en/versions/2.0.4/building-blocks/model"},{"title":"Context","href":"/en/versions/2.0.4/building-blocks/context"},{"title":"Tool","href":"/en/versions/2.0.4/building-blocks/tool"},{"title":"Plan","href":"/en/versions/2.0.4/building-blocks/plan"},{"title":"Permission System","href":"/en/versions/2.0.4/building-blocks/permission-system"},{"title":"Middleware","href":"/en/versions/2.0.4/building-blocks/middleware"},{"title":"RAG","href":"/en/versions/2.0.4/building-blocks/rag"},{"title":"Long-Term Memory","href":"/en/versions/2.0.4/building-blocks/long-term-memory"},{"title":"Workspace","href":"/en/versions/2.0.4/building-blocks/workspace"}]},{"group":"Agent as Service","pages":[{"title":"Architecture","href":"/en/versions/2.0.4/deploy/agent-service"},{"title":"Agent Team","href":"/en/versions/2.0.4/deploy/agent-team"},{"title":"RAG Service","href":"/en/versions/2.0.4/deploy/rag"},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","description":"Replace the payload of an existing credential.\n\nArgs:\n credential_id (`str`): The credential to update.\n body (`UpdateCredentialRequest`): New credential payload.\n user_id (`str`): Injected authenticated user ID.\n storage (`StorageBase`): Injected storage backend.\n\nReturns:\n `CredentialRecord`: The updated credential record.\n\nRaises:\n `HTTPException`: 404 if the credential does not exist or does not\n belong to the authenticated user.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"JSON Schema for the KB middleware's tunable parameters","description":"Return the parameter schema for\n:class:`agentscope.middleware.RAGMiddleware`.\n\nThe schema is shaped like every other ``parameter_schema`` served\nby this service — title / description / default / enum / minimum\n/ maximum — so the front-end can render the session-level KB\nattachment form with the same schema-driven component used for\nmodel parameters.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n\nReturns:\n `KbMiddlewareParametersSchemaResponse`:\n The JSON Schema describing the middleware's\n user-tunable parameters.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]}]}]},{"group":"Others","pages":[{"title":"FAQ","href":"/en/versions/2.0.4/others/faq"},{"title":"Changelog","href":"/en/versions/2.0.4/others/change-log"}]}]},{"version":"2.0.3","groups":[{"group":"Get Started","pages":[{"title":"What's AgentScope 2.0?","href":"/en/versions/2.0.3"},{"title":"Quickstart","href":"/en/versions/2.0.3/quickstart"},{"title":"Release Notes","href":"/en/versions/2.0.3/release-notes"}]},{"group":"Building Blocks","pages":[{"title":"Message \u0026 Event","href":"/en/versions/2.0.3/building-blocks/message-and-event"},{"title":"Agent","href":"/en/versions/2.0.3/building-blocks/agent"},{"title":"Model","href":"/en/versions/2.0.3/building-blocks/model"},{"title":"Context","href":"/en/versions/2.0.3/building-blocks/context"},{"title":"Tool","href":"/en/versions/2.0.3/building-blocks/tool"},{"title":"Plan","href":"/en/versions/2.0.3/building-blocks/plan"},{"title":"Permission System","href":"/en/versions/2.0.3/building-blocks/permission-system"},{"title":"Middleware","href":"/en/versions/2.0.3/building-blocks/middleware"},{"title":"RAG","href":"/en/versions/2.0.3/building-blocks/rag"},{"title":"Long-Term Memory","href":"/en/versions/2.0.3/building-blocks/long-term-memory"},{"title":"Workspace","href":"/en/versions/2.0.3/building-blocks/workspace"}]},{"group":"Agent as Service","pages":[{"title":"Architecture","href":"/en/versions/2.0.3/deploy/agent-service"},{"title":"Agent Team","href":"/en/versions/2.0.3/deploy/agent-team"},{"title":"RAG Service","href":"/en/versions/2.0.3/deploy/rag"},{"group":"API","pages":[{"group":"agent","pages":[{"title":"Get JSON Schema fragments for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/get-json-schema-fragments-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","description":"Replace the payload of an existing credential.\n\nArgs:\n credential_id (`str`): The credential to update.\n body (`UpdateCredentialRequest`): New credential payload.\n user_id (`str`): Injected authenticated user ID.\n storage (`StorageBase`): Injected storage backend.\n\nReturns:\n `CredentialRecord`: The updated credential record.\n\nRaises:\n `HTTPException`: 404 if the credential does not exist or does not\n belong to the authenticated user.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"JSON Schema for the KB middleware's tunable parameters","description":"Return the parameter schema for\n:class:`agentscope.middleware.RAGMiddleware`.\n\nThe schema is shaped like every other ``parameter_schema`` served\nby this service — title / description / default / enum / minimum\n/ maximum — so the front-end can render the session-level KB\nattachment form with the same schema-driven component used for\nmodel parameters.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n\nReturns:\n `KbMiddlewareParametersSchemaResponse`:\n The JSON Schema describing the middleware's\n user-tunable parameters.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]}]}]},{"group":"Others","pages":[{"title":"FAQ","href":"/en/versions/2.0.3/others/faq"},{"title":"Changelog","href":"/en/versions/2.0.3/others/change-log"}]}]},{"version":"2.0.2","pages":[{"title":"2.0.2","href":"/en/versions/2.0.2"}]},{"version":"1.0.21","pages":[{"title":"1.0.21","href":"/en/versions/1.0.21"}]}]},{"tab":"ReMe","versions":[{"version":"latest","groups":[{"group":"Get Started","pages":[{"title":"What's ReMe?","href":"/en/reme/latest/overview"},{"title":"Quick Start","href":"/en/reme/latest/quickstart"},{"title":"Concepts","href":"/en/reme/latest/concepts"}]},{"group":"Integration","pages":[{"title":"Overview","href":"/en/reme/latest/integration/overview"},{"title":"Deployment","href":"/en/reme/latest/integration/deployment"},{"title":"Python SDK","href":"/en/reme/latest/integration/python-sdk"},{"title":"Agent Integrations","href":"/en/reme/latest/integration/plugins"}]},{"group":"Resources","pages":[{"title":"Reference","href":"/en/reme/latest/reference"},{"title":"FAQ","href":"/en/reme/latest/faq"},{"title":"Contribution","href":"/en/reme/latest/contribution"}]}]}]}]},{"language":"zh","tabs":[{"tab":"AgentScope","versions":[{"version":"2.0.12dev","tag":"Development","groups":[{"group":"快速开始","pages":[{"title":"AgentScope 2.0 是什么?","href":"/zh/versions/2.0.12dev/index"},{"title":"快速开始","href":"/zh/versions/2.0.12dev/quickstart"},{"title":"更新日志","href":"/zh/versions/2.0.12dev/release-notes"}]},{"group":"核心模块","pages":[{"title":"消息与事件","href":"/zh/versions/2.0.12dev/building-blocks/message-and-event"},{"group":"智能体","pages":[{"title":"概述","href":"/zh/versions/2.0.12dev/building-blocks/agent/overview"},{"title":"配置智能体","href":"/zh/versions/2.0.12dev/building-blocks/agent/configure-agent"},{"title":"运行智能体","href":"/zh/versions/2.0.12dev/building-blocks/agent/run-agent"},{"title":"中断智能体","href":"/zh/versions/2.0.12dev/building-blocks/agent/interrupt-agent"},{"title":"人机交互","href":"/zh/versions/2.0.12dev/building-blocks/agent/human-in-the-loop"}]},{"group":"模型","pages":[{"title":"概述","href":"/zh/versions/2.0.12dev/building-blocks/model/overview"},{"title":"大语言模型","href":"/zh/versions/2.0.12dev/building-blocks/model/llm"},{"title":"语音合成","href":"/zh/versions/2.0.12dev/building-blocks/model/tts"},{"title":"语音识别","href":"/zh/versions/2.0.12dev/building-blocks/model/asr"},{"title":"嵌入模型","href":"/zh/versions/2.0.12dev/building-blocks/model/embedding"}]},{"group":"上下文管理","pages":[{"title":"概述","href":"/zh/versions/2.0.12dev/building-blocks/context/overview"},{"title":"感知环境","href":"/zh/versions/2.0.12dev/building-blocks/context/environment-awareness"},{"title":"压缩上下文","href":"/zh/versions/2.0.12dev/building-blocks/context/compress-context"},{"title":"卸载上下文","href":"/zh/versions/2.0.12dev/building-blocks/context/offload-context"}]},{"group":"工具","pages":[{"title":"概述","href":"/zh/versions/2.0.12dev/building-blocks/tool/overview"},{"title":"Python 函数工具","href":"/zh/versions/2.0.12dev/building-blocks/tool/python-tool"},{"title":"MCP","href":"/zh/versions/2.0.12dev/building-blocks/tool/mcp"},{"title":"Skill","href":"/zh/versions/2.0.12dev/building-blocks/tool/skill"},{"title":"元工具","href":"/zh/versions/2.0.12dev/building-blocks/tool/manage-tools"}]},{"title":"计划模式","href":"/zh/versions/2.0.12dev/building-blocks/plan"},{"group":"流水线","tag":"EXP","pages":[{"title":"概述","href":"/zh/versions/2.0.12dev/building-blocks/pipeline/overview"},{"title":"目标流水线","href":"/zh/versions/2.0.12dev/building-blocks/pipeline/goal"},{"title":"团队流水线","href":"/zh/versions/2.0.12dev/building-blocks/pipeline/team"}]},{"title":"标准作业流程","tag":"EXP","href":"/zh/versions/2.0.12dev/building-blocks/sop"},{"group":"权限系统","pages":[{"title":"概述","href":"/zh/versions/2.0.12dev/building-blocks/permission-system/overview"},{"title":"权限模式","href":"/zh/versions/2.0.12dev/building-blocks/permission-system/permission-mode"},{"title":"权限规则","href":"/zh/versions/2.0.12dev/building-blocks/permission-system/permission-rule"},{"title":"工具内置检查","href":"/zh/versions/2.0.12dev/building-blocks/permission-system/tool-check"}]},{"title":"中间件","href":"/zh/versions/2.0.12dev/building-blocks/middleware"},{"title":"RAG","href":"/zh/versions/2.0.12dev/building-blocks/rag"},{"title":"长期记忆","href":"/zh/versions/2.0.12dev/building-blocks/long-term-memory"},{"group":"工作区","pages":[{"title":"概述","href":"/zh/versions/2.0.12dev/building-blocks/workspace/overview"},{"title":"运行工作区","href":"/zh/versions/2.0.12dev/building-blocks/workspace/run-workspace"},{"title":"管理资源","href":"/zh/versions/2.0.12dev/building-blocks/workspace/manage-resources"},{"title":"MCP 网关","href":"/zh/versions/2.0.12dev/building-blocks/workspace/mcp-gateway"}]},{"group":"实时语音智能体","tag":"EXP","pages":[{"title":"概述","href":"/zh/versions/2.0.12dev/building-blocks/realtime/overview"},{"title":"语音到语音","href":"/zh/versions/2.0.12dev/building-blocks/realtime/speech-to-speech"}]},{"title":"终端 UI","href":"/zh/versions/2.0.12dev/building-blocks/console"},{"title":"A2A 协议","href":"/zh/versions/2.0.12dev/building-blocks/a2a"}]},{"group":"智能体即服务","pages":[{"title":"架构","href":"/zh/versions/2.0.12dev/deploy/agent-service"},{"title":"智能体团队","href":"/zh/versions/2.0.12dev/deploy/agent-team"},{"title":"SOP 服务","tag":"EXP","href":"/zh/versions/2.0.12dev/deploy/sop"},{"title":"资源共享","tag":"NEW","href":"/zh/versions/2.0.12dev/deploy/sharing"},{"title":"RAG 服务","href":"/zh/versions/2.0.12dev/deploy/rag"},{"title":"工作区管理","href":"/zh/versions/2.0.12dev/deploy/workspace-manager"},{"group":"MCP 与技能中心","pages":[{"title":"概览","href":"/zh/versions/2.0.12dev/deploy/hub/overview"},{"title":"MCP 中心","href":"/zh/versions/2.0.12dev/deploy/hub/mcp-hub"},{"title":"技能中心","href":"/zh/versions/2.0.12dev/deploy/hub/skill-hub"}]},{"group":"消息渠道","pages":[{"title":"概览","href":"/zh/versions/2.0.12dev/deploy/channel/overview"},{"title":"会话路由","href":"/zh/versions/2.0.12dev/deploy/channel/routing"},{"title":"飞书","href":"/zh/versions/2.0.12dev/deploy/channel/feishu"},{"title":"钉钉","href":"/zh/versions/2.0.12dev/deploy/channel/dingtalk"},{"title":"Discord","href":"/zh/versions/2.0.12dev/deploy/channel/discord"},{"title":"自定义渠道","href":"/zh/versions/2.0.12dev/deploy/channel/custom"}]},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"health","pages":[{"title":"Report service liveness and per-component readiness","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /health","href":"/api-reference/health/report-service-liveness-and-per-component-readiness"}]},{"group":"hub","pages":[{"title":"List Mcp Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp","href":"/api-reference/hub/list-mcp-hubs"},{"title":"List Mcp Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards","href":"/api-reference/hub/list-mcp-cards"},{"title":"Get Mcp Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-mcp-card"},{"title":"Install Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/mcp/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-mcp"},{"title":"List Skill Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill","href":"/api-reference/hub/list-skill-hubs"},{"title":"List Skill Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards","href":"/api-reference/hub/list-skill-cards"},{"title":"Install Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/skill/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-skill"},{"title":"Get Skill Card","description":"Return one skill card, including its ``SKILL.md`` body.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-skill-card"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"List available chunker types and their parameter schemas","description":"List every available chunker type with its parameter schema.\n\nThe front-end uses this to populate the chunker selector and\nto render a dynamic parameter form when creating a knowledge\nbase.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n chunker_classes (`list[type[ChunkerBase]]`):\n The chunker classes configured via\n ``create_app(knowledge_chunkers=...)``.\n\nReturns:\n `ListChunkersResponse`:\n All available chunker types with their JSON Schemas.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/chunkers","href":"/api-reference/knowledge_bases/list-available-chunker-types-and-their-parameter-schemas"},{"title":"JSON Schema for the KB middleware's tunable parameters","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Fetch the original uploaded file of a document","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/fetch-the-original-uploaded-file-of-a-document"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"},{"title":"Browse one document's chunks in order","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}/chunks","href":"/api-reference/knowledge_bases/browse-one-documents-chunks-in-order"},{"title":"Mint a short-lived token for a browser-native fetch","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents/{document_id}/download_token","href":"/api-reference/knowledge_bases/mint-a-short-lived-token-for-a-browser-native-fetch"}]},{"group":"mcp","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /mcp","href":"/api-reference/mcp/list-mcps"},{"title":"Delete Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /mcp/{mcp_id}","href":"/api-reference/mcp/delete-mcp"},{"title":"Update Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /mcp/{mcp_id}","href":"/api-reference/mcp/update-mcp"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"skill","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill","href":"/api-reference/skill/list-skills"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill/{skill_id}","href":"/api-reference/skill/get-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /skill/{skill_id}","href":"/api-reference/skill/delete-skill"}]},{"group":"sop","pages":[{"title":"The schema a procedure's editor is built from","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/schema","href":"/api-reference/sop/the-schema-a-procedures-editor-is-built-from"},{"title":"List procedures","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/","href":"/api-reference/sop/list-procedures"},{"title":"Create a procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/","href":"/api-reference/sop/create-a-procedure"},{"title":"List runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs","href":"/api-reference/sop/list-runs"},{"title":"Read one run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs/{sop_run_id}","href":"/api-reference/sop/read-one-run"},{"title":"Delete a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/runs/{sop_run_id}","href":"/api-reference/sop/delete-a-run"},{"title":"File a person's verdict on a step","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/runs/{sop_run_id}/verdict","href":"/api-reference/sop/file-a-persons-verdict-on-a-step"},{"title":"Read one procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/{sop_id}","href":"/api-reference/sop/read-one-procedure"},{"title":"Delete a procedure and its runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/{sop_id}","href":"/api-reference/sop/delete-a-procedure-and-its-runs"},{"title":"Replace a procedure's contents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json patch /sop/{sop_id}","href":"/api-reference/sop/replace-a-procedures-contents"},{"title":"Start a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/{sop_id}/runs","href":"/api-reference/sop/start-a-run"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Add Mcps From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/mcp/from-library","href":"/api-reference/workspace/add-mcps-from-library"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Upload Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/upload","href":"/api-reference/workspace/upload-skill"},{"title":"Add Skills From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/from-library","href":"/api-reference/workspace/add-skills-from-library"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"},{"title":"List Workspace Directory","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/directories","href":"/api-reference/workspace/list-workspace-directory"},{"title":"Get Workspace Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /workspace/status","href":"/api-reference/workspace/get-workspace-status"},{"title":"Create Download Token","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/files/download-token","href":"/api-reference/workspace/create-download-token"},{"title":"Read Workspace File","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/files","href":"/api-reference/workspace/read-workspace-file"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"realtime","pages":[{"title":"List realtime models for a credential provider","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json get /realtime/models","href":"/api-reference/realtime/list-realtime-models-for-a-credential-provider"},{"title":"Get browser WebRTC configuration","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json get /realtime/config","href":"/api-reference/realtime/get-browser-webrtc-configuration"},{"title":"Start a realtime session from a WebRTC offer","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json post /realtime/sessions/{session_id}/offer","href":"/api-reference/realtime/start-a-realtime-session-from-a-webrtc-offer"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]},{"group":"embedding-model","pages":[{"title":"List all candidate embedding models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /embedding-model/","href":"/api-reference/embedding-model/list-all-candidate-embedding-models-under-the-given-credential-type"}]},{"group":"channels","pages":[{"title":"List Channel Types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/types","href":"/api-reference/channels/list-channel-types"},{"title":"List Channels","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/","href":"/api-reference/channels/list-channels"},{"title":"Create Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/","href":"/api-reference/channels/create-channel"},{"title":"Start Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings","href":"/api-reference/channels/start-credential-binding"},{"title":"Poll Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /channels/bindings/{binding_id}","href":"/api-reference/channels/poll-credential-binding"},{"title":"Cancel Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings/{binding_id}/cancel","href":"/api-reference/channels/cancel-credential-binding"},{"title":"Get Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-channel"},{"title":"Delete Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-channel"},{"title":"Update Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-channel"},{"title":"Enable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/enable","href":"/api-reference/channels/enable-channel"},{"title":"Disable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/disable","href":"/api-reference/channels/disable-channel"},{"title":"Channel Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/status","href":"/api-reference/channels/channel-status"},{"title":"List Channel Sessions","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/sessions","href":"/api-reference/channels/list-channel-sessions"},{"title":"List Chat Ids","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/chat_ids","href":"/api-reference/channels/list-chat-ids"}]}]}]},{"group":"其他","pages":[{"title":"常见问题","href":"/zh/versions/2.0.12dev/others/faq"},{"title":"版本迁移","href":"/zh/versions/2.0.12dev/others/change-log"}]}]},{"version":"2.0.11","default":true,"groups":[{"group":"快速开始","pages":[{"title":"AgentScope 2.0 是什么?","href":"/zh/versions/2.0.11"},{"title":"快速开始","href":"/zh/versions/2.0.11/quickstart"},{"title":"更新日志","href":"/zh/versions/2.0.11/release-notes"}]},{"group":"核心模块","pages":[{"title":"消息与事件","href":"/zh/versions/2.0.11/building-blocks/message-and-event"},{"group":"智能体","pages":[{"title":"概述","href":"/zh/versions/2.0.11/building-blocks/agent/overview"},{"title":"配置智能体","href":"/zh/versions/2.0.11/building-blocks/agent/configure-agent"},{"title":"运行智能体","href":"/zh/versions/2.0.11/building-blocks/agent/run-agent"},{"title":"中断智能体","href":"/zh/versions/2.0.11/building-blocks/agent/interrupt-agent"},{"title":"人机交互","href":"/zh/versions/2.0.11/building-blocks/agent/human-in-the-loop"}]},{"group":"模型","pages":[{"title":"概述","href":"/zh/versions/2.0.11/building-blocks/model/overview"},{"title":"大语言模型","href":"/zh/versions/2.0.11/building-blocks/model/llm"},{"title":"语音合成","href":"/zh/versions/2.0.11/building-blocks/model/tts"},{"title":"语音识别","href":"/zh/versions/2.0.11/building-blocks/model/asr"},{"title":"嵌入模型","href":"/zh/versions/2.0.11/building-blocks/model/embedding"}]},{"group":"上下文管理","pages":[{"title":"概述","href":"/zh/versions/2.0.11/building-blocks/context/overview"},{"title":"感知环境","href":"/zh/versions/2.0.11/building-blocks/context/environment-awareness"},{"title":"压缩上下文","href":"/zh/versions/2.0.11/building-blocks/context/compress-context"},{"title":"卸载上下文","href":"/zh/versions/2.0.11/building-blocks/context/offload-context"}]},{"group":"工具","pages":[{"title":"概述","href":"/zh/versions/2.0.11/building-blocks/tool/overview"},{"title":"Python 函数工具","href":"/zh/versions/2.0.11/building-blocks/tool/python-tool"},{"title":"MCP","href":"/zh/versions/2.0.11/building-blocks/tool/mcp"},{"title":"Skill","href":"/zh/versions/2.0.11/building-blocks/tool/skill"},{"title":"元工具","href":"/zh/versions/2.0.11/building-blocks/tool/manage-tools"}]},{"title":"计划模式","href":"/zh/versions/2.0.11/building-blocks/plan"},{"group":"流水线","tag":"EXP","pages":[{"title":"概述","href":"/zh/versions/2.0.11/building-blocks/pipeline/overview"},{"title":"目标流水线","href":"/zh/versions/2.0.11/building-blocks/pipeline/goal"},{"title":"团队流水线","href":"/zh/versions/2.0.11/building-blocks/pipeline/team"}]},{"title":"标准作业流程","tag":"EXP","href":"/zh/versions/2.0.11/building-blocks/sop"},{"group":"权限系统","pages":[{"title":"概述","href":"/zh/versions/2.0.11/building-blocks/permission-system/overview"},{"title":"权限模式","href":"/zh/versions/2.0.11/building-blocks/permission-system/permission-mode"},{"title":"权限规则","href":"/zh/versions/2.0.11/building-blocks/permission-system/permission-rule"},{"title":"工具内置检查","href":"/zh/versions/2.0.11/building-blocks/permission-system/tool-check"}]},{"title":"中间件","href":"/zh/versions/2.0.11/building-blocks/middleware"},{"title":"RAG","href":"/zh/versions/2.0.11/building-blocks/rag"},{"title":"长期记忆","href":"/zh/versions/2.0.11/building-blocks/long-term-memory"},{"group":"工作区","pages":[{"title":"概述","href":"/zh/versions/2.0.11/building-blocks/workspace/overview"},{"title":"运行工作区","href":"/zh/versions/2.0.11/building-blocks/workspace/run-workspace"},{"title":"管理资源","href":"/zh/versions/2.0.11/building-blocks/workspace/manage-resources"},{"title":"MCP 网关","href":"/zh/versions/2.0.11/building-blocks/workspace/mcp-gateway"}]},{"group":"实时语音智能体","tag":"EXP","pages":[{"title":"概述","href":"/zh/versions/2.0.11/building-blocks/realtime/overview"},{"title":"语音到语音","href":"/zh/versions/2.0.11/building-blocks/realtime/speech-to-speech"}]},{"title":"终端 UI","href":"/zh/versions/2.0.11/building-blocks/console"},{"title":"A2A 协议","href":"/zh/versions/2.0.11/building-blocks/a2a"}]},{"group":"智能体即服务","pages":[{"title":"架构","href":"/zh/versions/2.0.11/deploy/agent-service"},{"title":"智能体团队","href":"/zh/versions/2.0.11/deploy/agent-team"},{"title":"SOP 服务","tag":"EXP","href":"/zh/versions/2.0.11/deploy/sop"},{"title":"资源共享","tag":"NEW","href":"/zh/versions/2.0.11/deploy/sharing"},{"title":"RAG 服务","href":"/zh/versions/2.0.11/deploy/rag"},{"title":"工作区管理","href":"/zh/versions/2.0.11/deploy/workspace-manager"},{"group":"MCP 与技能中心","pages":[{"title":"概览","href":"/zh/versions/2.0.11/deploy/hub/overview"},{"title":"MCP 中心","href":"/zh/versions/2.0.11/deploy/hub/mcp-hub"},{"title":"技能中心","href":"/zh/versions/2.0.11/deploy/hub/skill-hub"}]},{"group":"消息渠道","pages":[{"title":"概览","href":"/zh/versions/2.0.11/deploy/channel/overview"},{"title":"会话路由","href":"/zh/versions/2.0.11/deploy/channel/routing"},{"title":"飞书","href":"/zh/versions/2.0.11/deploy/channel/feishu"},{"title":"钉钉","href":"/zh/versions/2.0.11/deploy/channel/dingtalk"},{"title":"Discord","href":"/zh/versions/2.0.11/deploy/channel/discord"},{"title":"自定义渠道","href":"/zh/versions/2.0.11/deploy/channel/custom"}]},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"health","pages":[{"title":"Report service liveness and per-component readiness","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /health","href":"/api-reference/health/report-service-liveness-and-per-component-readiness"}]},{"group":"hub","pages":[{"title":"List Mcp Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp","href":"/api-reference/hub/list-mcp-hubs"},{"title":"List Mcp Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards","href":"/api-reference/hub/list-mcp-cards"},{"title":"Get Mcp Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-mcp-card"},{"title":"Install Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/mcp/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-mcp"},{"title":"List Skill Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill","href":"/api-reference/hub/list-skill-hubs"},{"title":"List Skill Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards","href":"/api-reference/hub/list-skill-cards"},{"title":"Install Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/skill/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-skill"},{"title":"Get Skill Card","description":"Return one skill card, including its ``SKILL.md`` body.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-skill-card"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"List available chunker types and their parameter schemas","description":"List every available chunker type with its parameter schema.\n\nThe front-end uses this to populate the chunker selector and\nto render a dynamic parameter form when creating a knowledge\nbase.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n chunker_classes (`list[type[ChunkerBase]]`):\n The chunker classes configured via\n ``create_app(knowledge_chunkers=...)``.\n\nReturns:\n `ListChunkersResponse`:\n All available chunker types with their JSON Schemas.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/chunkers","href":"/api-reference/knowledge_bases/list-available-chunker-types-and-their-parameter-schemas"},{"title":"JSON Schema for the KB middleware's tunable parameters","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Fetch the original uploaded file of a document","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/fetch-the-original-uploaded-file-of-a-document"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"},{"title":"Browse one document's chunks in order","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}/chunks","href":"/api-reference/knowledge_bases/browse-one-documents-chunks-in-order"},{"title":"Mint a short-lived token for a browser-native fetch","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents/{document_id}/download_token","href":"/api-reference/knowledge_bases/mint-a-short-lived-token-for-a-browser-native-fetch"}]},{"group":"mcp","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /mcp","href":"/api-reference/mcp/list-mcps"},{"title":"Delete Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /mcp/{mcp_id}","href":"/api-reference/mcp/delete-mcp"},{"title":"Update Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /mcp/{mcp_id}","href":"/api-reference/mcp/update-mcp"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"skill","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill","href":"/api-reference/skill/list-skills"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill/{skill_id}","href":"/api-reference/skill/get-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /skill/{skill_id}","href":"/api-reference/skill/delete-skill"}]},{"group":"sop","pages":[{"title":"The schema a procedure's editor is built from","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/schema","href":"/api-reference/sop/the-schema-a-procedures-editor-is-built-from"},{"title":"List procedures","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/","href":"/api-reference/sop/list-procedures"},{"title":"Create a procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/","href":"/api-reference/sop/create-a-procedure"},{"title":"List runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs","href":"/api-reference/sop/list-runs"},{"title":"Read one run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs/{sop_run_id}","href":"/api-reference/sop/read-one-run"},{"title":"Delete a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/runs/{sop_run_id}","href":"/api-reference/sop/delete-a-run"},{"title":"File a person's verdict on a step","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/runs/{sop_run_id}/verdict","href":"/api-reference/sop/file-a-persons-verdict-on-a-step"},{"title":"Read one procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/{sop_id}","href":"/api-reference/sop/read-one-procedure"},{"title":"Delete a procedure and its runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/{sop_id}","href":"/api-reference/sop/delete-a-procedure-and-its-runs"},{"title":"Replace a procedure's contents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json patch /sop/{sop_id}","href":"/api-reference/sop/replace-a-procedures-contents"},{"title":"Start a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/{sop_id}/runs","href":"/api-reference/sop/start-a-run"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Add Mcps From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/mcp/from-library","href":"/api-reference/workspace/add-mcps-from-library"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Upload Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/upload","href":"/api-reference/workspace/upload-skill"},{"title":"Add Skills From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/from-library","href":"/api-reference/workspace/add-skills-from-library"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"},{"title":"List Workspace Directory","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/directories","href":"/api-reference/workspace/list-workspace-directory"},{"title":"Get Workspace Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /workspace/status","href":"/api-reference/workspace/get-workspace-status"},{"title":"Create Download Token","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/files/download-token","href":"/api-reference/workspace/create-download-token"},{"title":"Read Workspace File","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/files","href":"/api-reference/workspace/read-workspace-file"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"realtime","pages":[{"title":"List realtime models for a credential provider","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json get /realtime/models","href":"/api-reference/realtime/list-realtime-models-for-a-credential-provider"},{"title":"Get browser WebRTC configuration","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json get /realtime/config","href":"/api-reference/realtime/get-browser-webrtc-configuration"},{"title":"Start a realtime session from a WebRTC offer","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json post /realtime/sessions/{session_id}/offer","href":"/api-reference/realtime/start-a-realtime-session-from-a-webrtc-offer"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]},{"group":"embedding-model","pages":[{"title":"List all candidate embedding models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /embedding-model/","href":"/api-reference/embedding-model/list-all-candidate-embedding-models-under-the-given-credential-type"}]},{"group":"channels","pages":[{"title":"List Channel Types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/types","href":"/api-reference/channels/list-channel-types"},{"title":"List Channels","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/","href":"/api-reference/channels/list-channels"},{"title":"Create Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/","href":"/api-reference/channels/create-channel"},{"title":"Start Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings","href":"/api-reference/channels/start-credential-binding"},{"title":"Poll Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /channels/bindings/{binding_id}","href":"/api-reference/channels/poll-credential-binding"},{"title":"Cancel Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings/{binding_id}/cancel","href":"/api-reference/channels/cancel-credential-binding"},{"title":"Get Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-channel"},{"title":"Delete Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-channel"},{"title":"Update Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-channel"},{"title":"Enable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/enable","href":"/api-reference/channels/enable-channel"},{"title":"Disable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/disable","href":"/api-reference/channels/disable-channel"},{"title":"Channel Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/status","href":"/api-reference/channels/channel-status"},{"title":"List Channel Sessions","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/sessions","href":"/api-reference/channels/list-channel-sessions"},{"title":"List Chat Ids","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/chat_ids","href":"/api-reference/channels/list-chat-ids"}]}]}]},{"group":"其他","pages":[{"title":"常见问题","href":"/zh/versions/2.0.11/others/faq"},{"title":"版本迁移","href":"/zh/versions/2.0.11/others/change-log"}]}]},{"version":"2.0.10","groups":[{"group":"快速开始","pages":[{"title":"AgentScope 2.0 是什么?","href":"/zh/versions/2.0.10/index"},{"title":"快速开始","href":"/zh/versions/2.0.10/quickstart"},{"title":"更新日志","href":"/zh/versions/2.0.10/release-notes"}]},{"group":"核心模块","pages":[{"title":"消息与事件","href":"/zh/versions/2.0.10/building-blocks/message-and-event"},{"group":"智能体","pages":[{"title":"概述","href":"/zh/versions/2.0.10/building-blocks/agent/overview"},{"title":"配置智能体","href":"/zh/versions/2.0.10/building-blocks/agent/configure-agent"},{"title":"运行智能体","href":"/zh/versions/2.0.10/building-blocks/agent/run-agent"},{"title":"中断智能体","href":"/zh/versions/2.0.10/building-blocks/agent/interrupt-agent"},{"title":"人机交互","href":"/zh/versions/2.0.10/building-blocks/agent/human-in-the-loop"}]},{"group":"模型","pages":[{"title":"概述","href":"/zh/versions/2.0.10/building-blocks/model/overview"},{"title":"大语言模型","href":"/zh/versions/2.0.10/building-blocks/model/llm"},{"title":"语音合成","href":"/zh/versions/2.0.10/building-blocks/model/tts"},{"title":"嵌入模型","href":"/zh/versions/2.0.10/building-blocks/model/embedding"}]},{"group":"上下文管理","pages":[{"title":"概述","href":"/zh/versions/2.0.10/building-blocks/context/overview"},{"title":"感知环境","href":"/zh/versions/2.0.10/building-blocks/context/environment-awareness"},{"title":"压缩上下文","href":"/zh/versions/2.0.10/building-blocks/context/compress-context"},{"title":"卸载上下文","href":"/zh/versions/2.0.10/building-blocks/context/offload-context"}]},{"group":"工具","pages":[{"title":"概述","href":"/zh/versions/2.0.10/building-blocks/tool/overview"},{"title":"Python 函数工具","href":"/zh/versions/2.0.10/building-blocks/tool/python-tool"},{"title":"MCP","href":"/zh/versions/2.0.10/building-blocks/tool/mcp"},{"title":"Skill","href":"/zh/versions/2.0.10/building-blocks/tool/skill"},{"title":"元工具","href":"/zh/versions/2.0.10/building-blocks/tool/manage-tools"}]},{"title":"计划模式","href":"/zh/versions/2.0.10/building-blocks/plan"},{"group":"流水线","tag":"EXP","pages":[{"title":"概述","href":"/zh/versions/2.0.10/building-blocks/pipeline/overview"},{"title":"目标流水线","href":"/zh/versions/2.0.10/building-blocks/pipeline/goal"},{"title":"团队流水线","href":"/zh/versions/2.0.10/building-blocks/pipeline/team"}]},{"title":"标准作业流程","tag":"EXP","href":"/zh/versions/2.0.10/building-blocks/sop"},{"group":"权限系统","pages":[{"title":"概述","href":"/zh/versions/2.0.10/building-blocks/permission-system/overview"},{"title":"权限模式","href":"/zh/versions/2.0.10/building-blocks/permission-system/permission-mode"},{"title":"权限规则","href":"/zh/versions/2.0.10/building-blocks/permission-system/permission-rule"},{"title":"工具内置检查","href":"/zh/versions/2.0.10/building-blocks/permission-system/tool-check"}]},{"title":"中间件","href":"/zh/versions/2.0.10/building-blocks/middleware"},{"title":"RAG","href":"/zh/versions/2.0.10/building-blocks/rag"},{"title":"长期记忆","href":"/zh/versions/2.0.10/building-blocks/long-term-memory"},{"group":"工作区","pages":[{"title":"概述","href":"/zh/versions/2.0.10/building-blocks/workspace/overview"},{"title":"运行工作区","href":"/zh/versions/2.0.10/building-blocks/workspace/run-workspace"},{"title":"管理资源","href":"/zh/versions/2.0.10/building-blocks/workspace/manage-resources"},{"title":"MCP 网关","href":"/zh/versions/2.0.10/building-blocks/workspace/mcp-gateway"}]},{"group":"实时语音智能体","tag":"EXP","pages":[{"title":"概述","href":"/zh/versions/2.0.10/building-blocks/realtime/overview"},{"title":"语音到语音","href":"/zh/versions/2.0.10/building-blocks/realtime/speech-to-speech"}]},{"title":"终端 UI","href":"/zh/versions/2.0.10/building-blocks/console"},{"title":"A2A 协议","href":"/zh/versions/2.0.10/building-blocks/a2a"}]},{"group":"智能体即服务","pages":[{"title":"架构","href":"/zh/versions/2.0.10/deploy/agent-service"},{"title":"智能体团队","href":"/zh/versions/2.0.10/deploy/agent-team"},{"title":"SOP 服务","tag":"EXP","href":"/zh/versions/2.0.10/deploy/sop"},{"title":"资源共享","tag":"NEW","href":"/zh/versions/2.0.10/deploy/sharing"},{"title":"RAG 服务","href":"/zh/versions/2.0.10/deploy/rag"},{"title":"工作区管理","href":"/zh/versions/2.0.10/deploy/workspace-manager"},{"group":"MCP 与技能中心","pages":[{"title":"概览","href":"/zh/versions/2.0.10/deploy/hub/overview"},{"title":"MCP 中心","href":"/zh/versions/2.0.10/deploy/hub/mcp-hub"},{"title":"技能中心","href":"/zh/versions/2.0.10/deploy/hub/skill-hub"}]},{"group":"消息渠道","pages":[{"title":"概览","href":"/zh/versions/2.0.10/deploy/channel/overview"},{"title":"会话路由","href":"/zh/versions/2.0.10/deploy/channel/routing"},{"title":"飞书","href":"/zh/versions/2.0.10/deploy/channel/feishu"},{"title":"钉钉","href":"/zh/versions/2.0.10/deploy/channel/dingtalk"},{"title":"Discord","href":"/zh/versions/2.0.10/deploy/channel/discord"},{"title":"自定义渠道","href":"/zh/versions/2.0.10/deploy/channel/custom"}]},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"health","pages":[{"title":"Report service liveness and per-component readiness","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /health","href":"/api-reference/health/report-service-liveness-and-per-component-readiness"}]},{"group":"hub","pages":[{"title":"List Mcp Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp","href":"/api-reference/hub/list-mcp-hubs"},{"title":"List Mcp Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards","href":"/api-reference/hub/list-mcp-cards"},{"title":"Get Mcp Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-mcp-card"},{"title":"Install Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/mcp/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-mcp"},{"title":"List Skill Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill","href":"/api-reference/hub/list-skill-hubs"},{"title":"List Skill Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards","href":"/api-reference/hub/list-skill-cards"},{"title":"Install Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/skill/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-skill"},{"title":"Get Skill Card","description":"Return one skill card, including its ``SKILL.md`` body.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-skill-card"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"List available chunker types and their parameter schemas","description":"List every available chunker type with its parameter schema.\n\nThe front-end uses this to populate the chunker selector and\nto render a dynamic parameter form when creating a knowledge\nbase.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n chunker_classes (`list[type[ChunkerBase]]`):\n The chunker classes configured via\n ``create_app(knowledge_chunkers=...)``.\n\nReturns:\n `ListChunkersResponse`:\n All available chunker types with their JSON Schemas.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/chunkers","href":"/api-reference/knowledge_bases/list-available-chunker-types-and-their-parameter-schemas"},{"title":"JSON Schema for the KB middleware's tunable parameters","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Fetch the original uploaded file of a document","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/fetch-the-original-uploaded-file-of-a-document"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"},{"title":"Browse one document's chunks in order","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}/chunks","href":"/api-reference/knowledge_bases/browse-one-documents-chunks-in-order"},{"title":"Mint a short-lived token for a browser-native fetch","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents/{document_id}/download_token","href":"/api-reference/knowledge_bases/mint-a-short-lived-token-for-a-browser-native-fetch"}]},{"group":"mcp","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /mcp","href":"/api-reference/mcp/list-mcps"},{"title":"Delete Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /mcp/{mcp_id}","href":"/api-reference/mcp/delete-mcp"},{"title":"Update Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /mcp/{mcp_id}","href":"/api-reference/mcp/update-mcp"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"skill","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill","href":"/api-reference/skill/list-skills"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill/{skill_id}","href":"/api-reference/skill/get-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /skill/{skill_id}","href":"/api-reference/skill/delete-skill"}]},{"group":"sop","pages":[{"title":"The schema a procedure's editor is built from","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/schema","href":"/api-reference/sop/the-schema-a-procedures-editor-is-built-from"},{"title":"List procedures","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/","href":"/api-reference/sop/list-procedures"},{"title":"Create a procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/","href":"/api-reference/sop/create-a-procedure"},{"title":"List runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs","href":"/api-reference/sop/list-runs"},{"title":"Read one run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs/{sop_run_id}","href":"/api-reference/sop/read-one-run"},{"title":"Delete a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/runs/{sop_run_id}","href":"/api-reference/sop/delete-a-run"},{"title":"File a person's verdict on a step","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/runs/{sop_run_id}/verdict","href":"/api-reference/sop/file-a-persons-verdict-on-a-step"},{"title":"Read one procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/{sop_id}","href":"/api-reference/sop/read-one-procedure"},{"title":"Delete a procedure and its runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/{sop_id}","href":"/api-reference/sop/delete-a-procedure-and-its-runs"},{"title":"Replace a procedure's contents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json patch /sop/{sop_id}","href":"/api-reference/sop/replace-a-procedures-contents"},{"title":"Start a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/{sop_id}/runs","href":"/api-reference/sop/start-a-run"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Add Mcps From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/mcp/from-library","href":"/api-reference/workspace/add-mcps-from-library"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Upload Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/upload","href":"/api-reference/workspace/upload-skill"},{"title":"Add Skills From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/from-library","href":"/api-reference/workspace/add-skills-from-library"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"},{"title":"List Workspace Directory","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/directories","href":"/api-reference/workspace/list-workspace-directory"},{"title":"Get Workspace Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /workspace/status","href":"/api-reference/workspace/get-workspace-status"},{"title":"Create Download Token","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/files/download-token","href":"/api-reference/workspace/create-download-token"},{"title":"Read Workspace File","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/files","href":"/api-reference/workspace/read-workspace-file"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"realtime","pages":[{"title":"List realtime models for a credential provider","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json get /realtime/models","href":"/api-reference/realtime/list-realtime-models-for-a-credential-provider"},{"title":"Get browser WebRTC configuration","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json get /realtime/config","href":"/api-reference/realtime/get-browser-webrtc-configuration"},{"title":"Start a realtime session from a WebRTC offer","deprecated":null,"version":null,"openapi":"/en/versions/2.0.10/deploy/openapi.json post /realtime/sessions/{session_id}/offer","href":"/api-reference/realtime/start-a-realtime-session-from-a-webrtc-offer"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]},{"group":"embedding-model","pages":[{"title":"List all candidate embedding models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /embedding-model/","href":"/api-reference/embedding-model/list-all-candidate-embedding-models-under-the-given-credential-type"}]},{"group":"channels","pages":[{"title":"List Channel Types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/types","href":"/api-reference/channels/list-channel-types"},{"title":"List Channels","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/","href":"/api-reference/channels/list-channels"},{"title":"Create Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/","href":"/api-reference/channels/create-channel"},{"title":"Start Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings","href":"/api-reference/channels/start-credential-binding"},{"title":"Poll Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /channels/bindings/{binding_id}","href":"/api-reference/channels/poll-credential-binding"},{"title":"Cancel Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings/{binding_id}/cancel","href":"/api-reference/channels/cancel-credential-binding"},{"title":"Get Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-channel"},{"title":"Delete Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-channel"},{"title":"Update Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-channel"},{"title":"Enable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/enable","href":"/api-reference/channels/enable-channel"},{"title":"Disable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/disable","href":"/api-reference/channels/disable-channel"},{"title":"Channel Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/status","href":"/api-reference/channels/channel-status"},{"title":"List Channel Sessions","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/sessions","href":"/api-reference/channels/list-channel-sessions"},{"title":"List Chat Ids","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/chat_ids","href":"/api-reference/channels/list-chat-ids"}]}]}]},{"group":"其他","pages":[{"title":"常见问题","href":"/zh/versions/2.0.10/others/faq"},{"title":"版本迁移","href":"/zh/versions/2.0.10/others/change-log"}]}]},{"version":"2.0.9","groups":[{"group":"快速开始","pages":[{"title":"AgentScope 2.0 是什么?","href":"/zh/versions/2.0.9/index"},{"title":"快速开始","href":"/zh/versions/2.0.9/quickstart"},{"title":"更新日志","href":"/zh/versions/2.0.9/release-notes"}]},{"group":"核心模块","pages":[{"title":"消息与事件","href":"/zh/versions/2.0.9/building-blocks/message-and-event"},{"group":"智能体","pages":[{"title":"概述","href":"/zh/versions/2.0.9/building-blocks/agent/overview"},{"title":"配置智能体","href":"/zh/versions/2.0.9/building-blocks/agent/configure-agent"},{"title":"运行智能体","href":"/zh/versions/2.0.9/building-blocks/agent/run-agent"},{"title":"中断智能体","href":"/zh/versions/2.0.9/building-blocks/agent/interrupt-agent"},{"title":"人机交互","href":"/zh/versions/2.0.9/building-blocks/agent/human-in-the-loop"}]},{"group":"模型","pages":[{"title":"概述","href":"/zh/versions/2.0.9/building-blocks/model/overview"},{"title":"大语言模型","href":"/zh/versions/2.0.9/building-blocks/model/llm"},{"title":"语音合成","href":"/zh/versions/2.0.9/building-blocks/model/tts"},{"title":"嵌入模型","href":"/zh/versions/2.0.9/building-blocks/model/embedding"}]},{"group":"上下文管理","pages":[{"title":"概述","href":"/zh/versions/2.0.9/building-blocks/context/overview"},{"title":"感知环境","href":"/zh/versions/2.0.9/building-blocks/context/environment-awareness"},{"title":"压缩上下文","href":"/zh/versions/2.0.9/building-blocks/context/compress-context"},{"title":"卸载上下文","href":"/zh/versions/2.0.9/building-blocks/context/offload-context"}]},{"group":"工具","pages":[{"title":"概述","href":"/zh/versions/2.0.9/building-blocks/tool/overview"},{"title":"Python 函数工具","href":"/zh/versions/2.0.9/building-blocks/tool/python-tool"},{"title":"MCP","href":"/zh/versions/2.0.9/building-blocks/tool/mcp"},{"title":"Skill","href":"/zh/versions/2.0.9/building-blocks/tool/skill"},{"title":"元工具","href":"/zh/versions/2.0.9/building-blocks/tool/manage-tools"}]},{"title":"计划模式","href":"/zh/versions/2.0.9/building-blocks/plan"},{"group":"流水线","tag":"EXP","pages":[{"title":"概述","href":"/zh/versions/2.0.9/building-blocks/pipeline/overview"},{"title":"目标流水线","href":"/zh/versions/2.0.9/building-blocks/pipeline/goal"},{"title":"团队流水线","href":"/zh/versions/2.0.9/building-blocks/pipeline/team"}]},{"title":"标准作业流程","tag":"EXP","href":"/zh/versions/2.0.9/building-blocks/sop"},{"group":"权限系统","pages":[{"title":"概述","href":"/zh/versions/2.0.9/building-blocks/permission-system/overview"},{"title":"权限模式","href":"/zh/versions/2.0.9/building-blocks/permission-system/permission-mode"},{"title":"权限规则","href":"/zh/versions/2.0.9/building-blocks/permission-system/permission-rule"},{"title":"工具内置检查","href":"/zh/versions/2.0.9/building-blocks/permission-system/tool-check"}]},{"title":"中间件","href":"/zh/versions/2.0.9/building-blocks/middleware"},{"title":"RAG","href":"/zh/versions/2.0.9/building-blocks/rag"},{"title":"长期记忆","href":"/zh/versions/2.0.9/building-blocks/long-term-memory"},{"group":"工作区","pages":[{"title":"概述","href":"/zh/versions/2.0.9/building-blocks/workspace/overview"},{"title":"运行工作区","href":"/zh/versions/2.0.9/building-blocks/workspace/run-workspace"},{"title":"管理资源","href":"/zh/versions/2.0.9/building-blocks/workspace/manage-resources"},{"title":"MCP 网关","href":"/zh/versions/2.0.9/building-blocks/workspace/mcp-gateway"}]},{"group":"实时语音智能体","tag":"EXP","pages":[{"title":"概述","href":"/zh/versions/2.0.9/building-blocks/realtime/overview"},{"title":"语音到语音","href":"/zh/versions/2.0.9/building-blocks/realtime/speech-to-speech"}]},{"title":"终端 UI","href":"/zh/versions/2.0.9/building-blocks/console"},{"title":"A2A 协议","href":"/zh/versions/2.0.9/building-blocks/a2a"}]},{"group":"智能体即服务","pages":[{"title":"架构","href":"/zh/versions/2.0.9/deploy/agent-service"},{"title":"智能体团队","href":"/zh/versions/2.0.9/deploy/agent-team"},{"title":"SOP 服务","tag":"EXP","href":"/zh/versions/2.0.9/deploy/sop"},{"title":"资源共享","tag":"NEW","href":"/zh/versions/2.0.9/deploy/sharing"},{"title":"RAG 服务","href":"/zh/versions/2.0.9/deploy/rag"},{"title":"工作区管理","href":"/zh/versions/2.0.9/deploy/workspace-manager"},{"group":"MCP 与技能中心","pages":[{"title":"概览","href":"/zh/versions/2.0.9/deploy/hub/overview"},{"title":"MCP 中心","href":"/zh/versions/2.0.9/deploy/hub/mcp-hub"},{"title":"技能中心","href":"/zh/versions/2.0.9/deploy/hub/skill-hub"}]},{"group":"消息渠道","pages":[{"title":"概览","href":"/zh/versions/2.0.9/deploy/channel/overview"},{"title":"会话路由","href":"/zh/versions/2.0.9/deploy/channel/routing"},{"title":"飞书","href":"/zh/versions/2.0.9/deploy/channel/feishu"},{"title":"钉钉","href":"/zh/versions/2.0.9/deploy/channel/dingtalk"},{"title":"Discord","href":"/zh/versions/2.0.9/deploy/channel/discord"},{"title":"自定义渠道","href":"/zh/versions/2.0.9/deploy/channel/custom"}]},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"health","pages":[{"title":"Report service liveness and per-component readiness","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /health","href":"/api-reference/health/report-service-liveness-and-per-component-readiness"}]},{"group":"hub","pages":[{"title":"List Mcp Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp","href":"/api-reference/hub/list-mcp-hubs"},{"title":"List Mcp Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards","href":"/api-reference/hub/list-mcp-cards"},{"title":"Get Mcp Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-mcp-card"},{"title":"Install Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/mcp/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-mcp"},{"title":"List Skill Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill","href":"/api-reference/hub/list-skill-hubs"},{"title":"List Skill Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards","href":"/api-reference/hub/list-skill-cards"},{"title":"Install Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/skill/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-skill"},{"title":"Get Skill Card","description":"Return one skill card, including its ``SKILL.md`` body.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-skill-card"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"List available chunker types and their parameter schemas","description":"List every available chunker type with its parameter schema.\n\nThe front-end uses this to populate the chunker selector and\nto render a dynamic parameter form when creating a knowledge\nbase.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n chunker_classes (`list[type[ChunkerBase]]`):\n The chunker classes configured via\n ``create_app(knowledge_chunkers=...)``.\n\nReturns:\n `ListChunkersResponse`:\n All available chunker types with their JSON Schemas.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/chunkers","href":"/api-reference/knowledge_bases/list-available-chunker-types-and-their-parameter-schemas"},{"title":"JSON Schema for the KB middleware's tunable parameters","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Fetch the original uploaded file of a document","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/fetch-the-original-uploaded-file-of-a-document"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"},{"title":"Browse one document's chunks in order","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/{document_id}/chunks","href":"/api-reference/knowledge_bases/browse-one-documents-chunks-in-order"},{"title":"Mint a short-lived token for a browser-native fetch","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents/{document_id}/download_token","href":"/api-reference/knowledge_bases/mint-a-short-lived-token-for-a-browser-native-fetch"}]},{"group":"mcp","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /mcp","href":"/api-reference/mcp/list-mcps"},{"title":"Delete Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /mcp/{mcp_id}","href":"/api-reference/mcp/delete-mcp"},{"title":"Update Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /mcp/{mcp_id}","href":"/api-reference/mcp/update-mcp"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"skill","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill","href":"/api-reference/skill/list-skills"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill/{skill_id}","href":"/api-reference/skill/get-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /skill/{skill_id}","href":"/api-reference/skill/delete-skill"}]},{"group":"sop","pages":[{"title":"The schema a procedure's editor is built from","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/schema","href":"/api-reference/sop/the-schema-a-procedures-editor-is-built-from"},{"title":"List procedures","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/","href":"/api-reference/sop/list-procedures"},{"title":"Create a procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/","href":"/api-reference/sop/create-a-procedure"},{"title":"List runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs","href":"/api-reference/sop/list-runs"},{"title":"Read one run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/runs/{sop_run_id}","href":"/api-reference/sop/read-one-run"},{"title":"Delete a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/runs/{sop_run_id}","href":"/api-reference/sop/delete-a-run"},{"title":"File a person's verdict on a step","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/runs/{sop_run_id}/verdict","href":"/api-reference/sop/file-a-persons-verdict-on-a-step"},{"title":"Read one procedure","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /sop/{sop_id}","href":"/api-reference/sop/read-one-procedure"},{"title":"Delete a procedure and its runs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json delete /sop/{sop_id}","href":"/api-reference/sop/delete-a-procedure-and-its-runs"},{"title":"Replace a procedure's contents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json patch /sop/{sop_id}","href":"/api-reference/sop/replace-a-procedures-contents"},{"title":"Start a run","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /sop/{sop_id}/runs","href":"/api-reference/sop/start-a-run"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Add Mcps From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/mcp/from-library","href":"/api-reference/workspace/add-mcps-from-library"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Upload Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/upload","href":"/api-reference/workspace/upload-skill"},{"title":"Add Skills From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/from-library","href":"/api-reference/workspace/add-skills-from-library"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"},{"title":"List Workspace Directory","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/directories","href":"/api-reference/workspace/list-workspace-directory"},{"title":"Get Workspace Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /workspace/status","href":"/api-reference/workspace/get-workspace-status"},{"title":"Create Download Token","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/files/download-token","href":"/api-reference/workspace/create-download-token"},{"title":"Read Workspace File","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/files","href":"/api-reference/workspace/read-workspace-file"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]},{"group":"embedding-model","pages":[{"title":"List all candidate embedding models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /embedding-model/","href":"/api-reference/embedding-model/list-all-candidate-embedding-models-under-the-given-credential-type"}]},{"group":"channels","pages":[{"title":"List Channel Types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/types","href":"/api-reference/channels/list-channel-types"},{"title":"List Channels","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/","href":"/api-reference/channels/list-channels"},{"title":"Create Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/","href":"/api-reference/channels/create-channel"},{"title":"Start Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings","href":"/api-reference/channels/start-credential-binding"},{"title":"Poll Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json get /channels/bindings/{binding_id}","href":"/api-reference/channels/poll-credential-binding"},{"title":"Cancel Credential Binding","deprecated":null,"version":null,"openapi":"/en/versions/2.0.9/deploy/openapi.json post /channels/bindings/{binding_id}/cancel","href":"/api-reference/channels/cancel-credential-binding"},{"title":"Get Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-channel"},{"title":"Delete Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-channel"},{"title":"Update Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-channel"},{"title":"Enable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/enable","href":"/api-reference/channels/enable-channel"},{"title":"Disable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/disable","href":"/api-reference/channels/disable-channel"},{"title":"Channel Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/status","href":"/api-reference/channels/channel-status"},{"title":"List Channel Sessions","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/sessions","href":"/api-reference/channels/list-channel-sessions"},{"title":"List Chat Ids","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/chat_ids","href":"/api-reference/channels/list-chat-ids"}]}]}]},{"group":"其他","pages":[{"title":"常见问题","href":"/zh/versions/2.0.9/others/faq"},{"title":"版本迁移","href":"/zh/versions/2.0.9/others/change-log"}]}]},{"version":"2.0.8","groups":[{"group":"快速开始","pages":[{"title":"AgentScope 2.0 是什么?","href":"/zh/versions/2.0.8/index"},{"title":"快速开始","href":"/zh/versions/2.0.8/quickstart"},{"title":"更新日志","href":"/zh/versions/2.0.8/release-notes"}]},{"group":"核心模块","pages":[{"title":"消息与事件","href":"/zh/versions/2.0.8/building-blocks/message-and-event"},{"group":"智能体","pages":[{"title":"概述","href":"/zh/versions/2.0.8/building-blocks/agent/overview"},{"title":"配置智能体","href":"/zh/versions/2.0.8/building-blocks/agent/configure-agent"},{"title":"运行智能体","href":"/zh/versions/2.0.8/building-blocks/agent/run-agent"},{"title":"中断智能体","href":"/zh/versions/2.0.8/building-blocks/agent/interrupt-agent"},{"title":"人机交互","href":"/zh/versions/2.0.8/building-blocks/agent/human-in-the-loop"}]},{"group":"模型","pages":[{"title":"概述","href":"/zh/versions/2.0.8/building-blocks/model/overview"},{"title":"大语言模型","href":"/zh/versions/2.0.8/building-blocks/model/llm"},{"title":"语音合成","href":"/zh/versions/2.0.8/building-blocks/model/tts"},{"title":"嵌入模型","href":"/zh/versions/2.0.8/building-blocks/model/embedding"}]},{"group":"上下文管理","pages":[{"title":"概述","href":"/zh/versions/2.0.8/building-blocks/context/overview"},{"title":"感知环境","href":"/zh/versions/2.0.8/building-blocks/context/environment-awareness"},{"title":"压缩上下文","href":"/zh/versions/2.0.8/building-blocks/context/compress-context"},{"title":"卸载上下文","href":"/zh/versions/2.0.8/building-blocks/context/offload-context"}]},{"group":"工具","pages":[{"title":"概述","href":"/zh/versions/2.0.8/building-blocks/tool/overview"},{"title":"Python 函数工具","href":"/zh/versions/2.0.8/building-blocks/tool/python-tool"},{"title":"MCP","href":"/zh/versions/2.0.8/building-blocks/tool/mcp"},{"title":"Skill","href":"/zh/versions/2.0.8/building-blocks/tool/skill"},{"title":"元工具","href":"/zh/versions/2.0.8/building-blocks/tool/manage-tools"}]},{"title":"计划模式","href":"/zh/versions/2.0.8/building-blocks/plan"},{"group":"流水线","tag":"EXP","pages":[{"title":"概述","href":"/zh/versions/2.0.8/building-blocks/pipeline/overview"},{"title":"目标流水线","href":"/zh/versions/2.0.8/building-blocks/pipeline/goal"}]},{"group":"权限系统","pages":[{"title":"概述","href":"/zh/versions/2.0.8/building-blocks/permission-system/overview"},{"title":"权限模式","href":"/zh/versions/2.0.8/building-blocks/permission-system/permission-mode"},{"title":"权限规则","href":"/zh/versions/2.0.8/building-blocks/permission-system/permission-rule"},{"title":"工具内置检查","href":"/zh/versions/2.0.8/building-blocks/permission-system/tool-check"}]},{"title":"中间件","href":"/zh/versions/2.0.8/building-blocks/middleware"},{"title":"RAG","href":"/zh/versions/2.0.8/building-blocks/rag"},{"title":"长期记忆","href":"/zh/versions/2.0.8/building-blocks/long-term-memory"},{"group":"工作区","pages":[{"title":"概述","href":"/zh/versions/2.0.8/building-blocks/workspace/overview"},{"title":"运行工作区","href":"/zh/versions/2.0.8/building-blocks/workspace/run-workspace"},{"title":"管理资源","href":"/zh/versions/2.0.8/building-blocks/workspace/manage-resources"},{"title":"MCP 网关","href":"/zh/versions/2.0.8/building-blocks/workspace/mcp-gateway"}]},{"group":"实时语音智能体","tag":"EXP","pages":[{"title":"概述","href":"/zh/versions/2.0.8/building-blocks/realtime/overview"},{"title":"语音到语音","href":"/zh/versions/2.0.8/building-blocks/realtime/speech-to-speech"}]},{"title":"终端 UI","href":"/zh/versions/2.0.8/building-blocks/console"},{"title":"A2A 协议","href":"/zh/versions/2.0.8/building-blocks/a2a"}]},{"group":"智能体即服务","pages":[{"title":"架构","href":"/zh/versions/2.0.8/deploy/agent-service"},{"title":"智能体团队","href":"/zh/versions/2.0.8/deploy/agent-team"},{"title":"资源共享","tag":"NEW","href":"/zh/versions/2.0.8/deploy/sharing"},{"title":"RAG 服务","href":"/zh/versions/2.0.8/deploy/rag"},{"title":"工作区管理","href":"/zh/versions/2.0.8/deploy/workspace-manager"},{"group":"MCP 与技能中心","pages":[{"title":"概览","href":"/zh/versions/2.0.8/deploy/hub/overview"},{"title":"MCP 中心","href":"/zh/versions/2.0.8/deploy/hub/mcp-hub"},{"title":"技能中心","href":"/zh/versions/2.0.8/deploy/hub/skill-hub"}]},{"group":"消息渠道","pages":[{"title":"概览","href":"/zh/versions/2.0.8/deploy/channel/overview"},{"title":"会话路由","href":"/zh/versions/2.0.8/deploy/channel/routing"},{"title":"飞书","href":"/zh/versions/2.0.8/deploy/channel/feishu"},{"title":"钉钉","href":"/zh/versions/2.0.8/deploy/channel/dingtalk"},{"title":"Discord","href":"/zh/versions/2.0.8/deploy/channel/discord"},{"title":"自定义渠道","href":"/zh/versions/2.0.8/deploy/channel/custom"}]},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"health","pages":[{"title":"Report service liveness and per-component readiness","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /health","href":"/api-reference/health/report-service-liveness-and-per-component-readiness"}]},{"group":"hub","pages":[{"title":"List Mcp Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp","href":"/api-reference/hub/list-mcp-hubs"},{"title":"List Mcp Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards","href":"/api-reference/hub/list-mcp-cards"},{"title":"Get Mcp Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-mcp-card"},{"title":"Install Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/mcp/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-mcp"},{"title":"List Skill Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill","href":"/api-reference/hub/list-skill-hubs"},{"title":"List Skill Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards","href":"/api-reference/hub/list-skill-cards"},{"title":"Get Skill Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-skill-card"},{"title":"Install Skill","description":"Add a skill card to the user's library.\n\nMirrors the MCP install: user-level, no workspace involved. The\narchive is not downloaded here — only the card's metadata is\nrecorded, and the files are fetched when the skill is actually put\ninto a workspace. So a hub that has since dropped the card fails\nthen rather than now.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/skill/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-skill"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"JSON Schema for the KB middleware's tunable parameters","description":"Return the parameter schema for\n:class:`agentscope.middleware.RAGMiddleware`.\n\nThe schema is shaped like every other ``parameter_schema`` served\nby this service — title / description / default / enum / minimum\n/ maximum — so the front-end can render the session-level KB\nattachment form with the same schema-driven component used for\nmodel parameters.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n\nReturns:\n `KbMiddlewareParametersSchemaResponse`:\n The JSON Schema describing the middleware's\n user-tunable parameters.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"}]},{"group":"mcp","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /mcp","href":"/api-reference/mcp/list-mcps"},{"title":"Delete Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /mcp/{mcp_id}","href":"/api-reference/mcp/delete-mcp"},{"title":"Update Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /mcp/{mcp_id}","href":"/api-reference/mcp/update-mcp"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"skill","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill","href":"/api-reference/skill/list-skills"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill/{skill_id}","href":"/api-reference/skill/get-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /skill/{skill_id}","href":"/api-reference/skill/delete-skill"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Add Mcps From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/mcp/from-library","href":"/api-reference/workspace/add-mcps-from-library"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Upload Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/upload","href":"/api-reference/workspace/upload-skill"},{"title":"Add Skills From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/from-library","href":"/api-reference/workspace/add-skills-from-library"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"},{"title":"List Workspace Directory","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/directories","href":"/api-reference/workspace/list-workspace-directory"},{"title":"Create Download Token","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/files/download-token","href":"/api-reference/workspace/create-download-token"},{"title":"Read Workspace File","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/files","href":"/api-reference/workspace/read-workspace-file"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]},{"group":"embedding-model","pages":[{"title":"List all candidate embedding models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /embedding-model/","href":"/api-reference/embedding-model/list-all-candidate-embedding-models-under-the-given-credential-type"}]},{"group":"channels","pages":[{"title":"List Channel Types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/types","href":"/api-reference/channels/list-channel-types"},{"title":"List Channels","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/","href":"/api-reference/channels/list-channels"},{"title":"Create Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/","href":"/api-reference/channels/create-channel"},{"title":"Get Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-channel"},{"title":"Delete Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-channel"},{"title":"Update Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-channel"},{"title":"Enable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/enable","href":"/api-reference/channels/enable-channel"},{"title":"Disable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/disable","href":"/api-reference/channels/disable-channel"},{"title":"Channel Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/status","href":"/api-reference/channels/channel-status"},{"title":"List Channel Sessions","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/sessions","href":"/api-reference/channels/list-channel-sessions"},{"title":"List Chat Ids","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/chat_ids","href":"/api-reference/channels/list-chat-ids"}]}]}]},{"group":"其他","pages":[{"title":"常见问题","href":"/zh/versions/2.0.8/others/faq"},{"title":"版本迁移","href":"/zh/versions/2.0.8/others/change-log"}]}]},{"version":"2.0.7","groups":[{"group":"快速开始","pages":[{"title":"AgentScope 2.0 是什么?","href":"/zh/versions/2.0.7/index"},{"title":"快速开始","href":"/zh/versions/2.0.7/quickstart"},{"title":"更新日志","href":"/zh/versions/2.0.7/release-notes"}]},{"group":"核心模块","pages":[{"title":"消息与事件","href":"/zh/versions/2.0.7/building-blocks/message-and-event"},{"group":"智能体","pages":[{"title":"概述","href":"/zh/versions/2.0.7/building-blocks/agent/overview"},{"title":"配置智能体","href":"/zh/versions/2.0.7/building-blocks/agent/configure-agent"},{"title":"运行智能体","href":"/zh/versions/2.0.7/building-blocks/agent/run-agent"},{"title":"中断智能体","href":"/zh/versions/2.0.7/building-blocks/agent/interrupt-agent"},{"title":"人机交互","href":"/zh/versions/2.0.7/building-blocks/agent/human-in-the-loop"}]},{"group":"模型","pages":[{"title":"概述","href":"/zh/versions/2.0.7/building-blocks/model/overview"},{"title":"大语言模型","href":"/zh/versions/2.0.7/building-blocks/model/llm"},{"title":"语音合成","href":"/zh/versions/2.0.7/building-blocks/model/tts"},{"title":"嵌入模型","href":"/zh/versions/2.0.7/building-blocks/model/embedding"}]},{"group":"上下文管理","pages":[{"title":"概述","href":"/zh/versions/2.0.7/building-blocks/context/overview"},{"title":"感知环境","href":"/zh/versions/2.0.7/building-blocks/context/environment-awareness"},{"title":"压缩上下文","href":"/zh/versions/2.0.7/building-blocks/context/compress-context"},{"title":"卸载上下文","href":"/zh/versions/2.0.7/building-blocks/context/offload-context"}]},{"group":"工具","pages":[{"title":"概述","href":"/zh/versions/2.0.7/building-blocks/tool/overview"},{"title":"Python 函数工具","href":"/zh/versions/2.0.7/building-blocks/tool/python-tool"},{"title":"MCP","href":"/zh/versions/2.0.7/building-blocks/tool/mcp"},{"title":"Skill","href":"/zh/versions/2.0.7/building-blocks/tool/skill"},{"title":"元工具","href":"/zh/versions/2.0.7/building-blocks/tool/manage-tools"}]},{"title":"计划模式","href":"/zh/versions/2.0.7/building-blocks/plan"},{"group":"权限系统","pages":[{"title":"概述","href":"/zh/versions/2.0.7/building-blocks/permission-system/overview"},{"title":"权限模式","href":"/zh/versions/2.0.7/building-blocks/permission-system/permission-mode"},{"title":"权限规则","href":"/zh/versions/2.0.7/building-blocks/permission-system/permission-rule"},{"title":"工具内置检查","href":"/zh/versions/2.0.7/building-blocks/permission-system/tool-check"}]},{"title":"中间件","href":"/zh/versions/2.0.7/building-blocks/middleware"},{"title":"RAG","href":"/zh/versions/2.0.7/building-blocks/rag"},{"title":"长期记忆","href":"/zh/versions/2.0.7/building-blocks/long-term-memory"},{"group":"工作区","pages":[{"title":"概述","href":"/zh/versions/2.0.7/building-blocks/workspace/overview"},{"title":"运行工作区","href":"/zh/versions/2.0.7/building-blocks/workspace/run-workspace"},{"title":"管理资源","href":"/zh/versions/2.0.7/building-blocks/workspace/manage-resources"},{"title":"MCP 网关","href":"/zh/versions/2.0.7/building-blocks/workspace/mcp-gateway"}]},{"title":"控制台","href":"/zh/versions/2.0.7/building-blocks/console"}]},{"group":"智能体即服务","pages":[{"title":"架构","href":"/zh/versions/2.0.7/deploy/agent-service"},{"title":"智能体团队","href":"/zh/versions/2.0.7/deploy/agent-team"},{"title":"资源共享","tag":"NEW","href":"/zh/versions/2.0.7/deploy/sharing"},{"title":"RAG 服务","href":"/zh/versions/2.0.7/deploy/rag"},{"title":"工作区管理","href":"/zh/versions/2.0.7/deploy/workspace-manager"},{"group":"MCP 与技能中心","tag":"NEW","pages":[{"title":"概览","href":"/zh/versions/2.0.7/deploy/hub/overview"},{"title":"MCP 中心","href":"/zh/versions/2.0.7/deploy/hub/mcp-hub"},{"title":"技能中心","href":"/zh/versions/2.0.7/deploy/hub/skill-hub"}]},{"group":"消息渠道","tag":"NEW","pages":[{"title":"概览","href":"/zh/versions/2.0.7/deploy/channel/overview"},{"title":"会话路由","href":"/zh/versions/2.0.7/deploy/channel/routing"},{"title":"飞书","href":"/zh/versions/2.0.7/deploy/channel/feishu"},{"title":"钉钉","href":"/zh/versions/2.0.7/deploy/channel/dingtalk"},{"title":"Discord","href":"/zh/versions/2.0.7/deploy/channel/discord"},{"title":"自定义渠道","href":"/zh/versions/2.0.7/deploy/channel/custom"}]},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"health","pages":[{"title":"Report service liveness and per-component readiness","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /health","href":"/api-reference/health/report-service-liveness-and-per-component-readiness"}]},{"group":"hub","pages":[{"title":"List Mcp Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp","href":"/api-reference/hub/list-mcp-hubs"},{"title":"List Mcp Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards","href":"/api-reference/hub/list-mcp-cards"},{"title":"Get Mcp Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-mcp-card"},{"title":"Install Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/mcp/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-mcp"},{"title":"List Skill Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill","href":"/api-reference/hub/list-skill-hubs"},{"title":"List Skill Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards","href":"/api-reference/hub/list-skill-cards"},{"title":"Get Skill Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-skill-card"},{"title":"Install Skill","description":"Add a skill card to the user's library.\n\nMirrors the MCP install: user-level, no workspace involved. The\narchive is not downloaded here — only the card's metadata is\nrecorded, and the files are fetched when the skill is actually put\ninto a workspace. So a hub that has since dropped the card fails\nthen rather than now.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/skill/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-skill"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"JSON Schema for the KB middleware's tunable parameters","description":"Return the parameter schema for\n:class:`agentscope.middleware.RAGMiddleware`.\n\nThe schema is shaped like every other ``parameter_schema`` served\nby this service — title / description / default / enum / minimum\n/ maximum — so the front-end can render the session-level KB\nattachment form with the same schema-driven component used for\nmodel parameters.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n\nReturns:\n `KbMiddlewareParametersSchemaResponse`:\n The JSON Schema describing the middleware's\n user-tunable parameters.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"}]},{"group":"mcp","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /mcp","href":"/api-reference/mcp/list-mcps"},{"title":"Delete Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /mcp/{mcp_id}","href":"/api-reference/mcp/delete-mcp"},{"title":"Update Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /mcp/{mcp_id}","href":"/api-reference/mcp/update-mcp"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"skill","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill","href":"/api-reference/skill/list-skills"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill/{skill_id}","href":"/api-reference/skill/get-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /skill/{skill_id}","href":"/api-reference/skill/delete-skill"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Add Mcps From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/mcp/from-library","href":"/api-reference/workspace/add-mcps-from-library"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Upload Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/upload","href":"/api-reference/workspace/upload-skill"},{"title":"Add Skills From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/from-library","href":"/api-reference/workspace/add-skills-from-library"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"},{"title":"List Workspace Directory","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/directories","href":"/api-reference/workspace/list-workspace-directory"},{"title":"Create Download Token","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/files/download-token","href":"/api-reference/workspace/create-download-token"},{"title":"Read Workspace File","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/files","href":"/api-reference/workspace/read-workspace-file"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]},{"group":"embedding-model","pages":[{"title":"List all candidate embedding models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /embedding-model/","href":"/api-reference/embedding-model/list-all-candidate-embedding-models-under-the-given-credential-type"}]},{"group":"channels","pages":[{"title":"List Channel Types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/types","href":"/api-reference/channels/list-channel-types"},{"title":"List Channels","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/","href":"/api-reference/channels/list-channels"},{"title":"Create Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/","href":"/api-reference/channels/create-channel"},{"title":"Get Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-channel"},{"title":"Delete Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-channel"},{"title":"Update Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-channel"},{"title":"Enable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/enable","href":"/api-reference/channels/enable-channel"},{"title":"Disable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/disable","href":"/api-reference/channels/disable-channel"},{"title":"Channel Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/status","href":"/api-reference/channels/channel-status"},{"title":"List Channel Sessions","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/sessions","href":"/api-reference/channels/list-channel-sessions"},{"title":"List Chat Ids","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/chat_ids","href":"/api-reference/channels/list-chat-ids"}]}]}]},{"group":"其他","pages":[{"title":"常见问题","href":"/zh/versions/2.0.7/others/faq"},{"title":"版本迁移","href":"/zh/versions/2.0.7/others/change-log"}]}]},{"version":"2.0.6","groups":[{"group":"快速开始","pages":[{"title":"AgentScope 2.0 是什么?","href":"/zh/versions/2.0.6/index"},{"title":"快速开始","href":"/zh/versions/2.0.6/quickstart"},{"title":"更新日志","href":"/zh/versions/2.0.6/release-notes"}]},{"group":"核心模块","pages":[{"title":"消息与事件","href":"/zh/versions/2.0.6/building-blocks/message-and-event"},{"group":"智能体","pages":[{"title":"概述","href":"/zh/versions/2.0.6/building-blocks/agent/overview"},{"title":"配置智能体","href":"/zh/versions/2.0.6/building-blocks/agent/configure-agent"},{"title":"运行智能体","href":"/zh/versions/2.0.6/building-blocks/agent/run-agent"},{"title":"中断智能体","href":"/zh/versions/2.0.6/building-blocks/agent/interrupt-agent"},{"title":"人机交互","href":"/zh/versions/2.0.6/building-blocks/agent/human-in-the-loop"}]},{"group":"模型","pages":[{"title":"概述","href":"/zh/versions/2.0.6/building-blocks/model/overview"},{"title":"大语言模型","href":"/zh/versions/2.0.6/building-blocks/model/llm"},{"title":"语音合成","href":"/zh/versions/2.0.6/building-blocks/model/tts"},{"title":"嵌入模型","href":"/zh/versions/2.0.6/building-blocks/model/embedding"}]},{"group":"上下文管理","pages":[{"title":"概述","href":"/zh/versions/2.0.6/building-blocks/context/overview"},{"title":"感知环境","href":"/zh/versions/2.0.6/building-blocks/context/environment-awareness"},{"title":"压缩上下文","href":"/zh/versions/2.0.6/building-blocks/context/compress-context"},{"title":"卸载上下文","href":"/zh/versions/2.0.6/building-blocks/context/offload-context"}]},{"group":"工具","pages":[{"title":"概述","href":"/zh/versions/2.0.6/building-blocks/tool/overview"},{"title":"Python 函数工具","href":"/zh/versions/2.0.6/building-blocks/tool/python-tool"},{"title":"MCP","href":"/zh/versions/2.0.6/building-blocks/tool/mcp"},{"title":"Skill","href":"/zh/versions/2.0.6/building-blocks/tool/skill"},{"title":"元工具","href":"/zh/versions/2.0.6/building-blocks/tool/manage-tools"}]},{"title":"计划模式","href":"/zh/versions/2.0.6/building-blocks/plan"},{"group":"权限系统","pages":[{"title":"概述","href":"/zh/versions/2.0.6/building-blocks/permission-system/overview"},{"title":"权限模式","href":"/zh/versions/2.0.6/building-blocks/permission-system/permission-mode"},{"title":"权限规则","href":"/zh/versions/2.0.6/building-blocks/permission-system/permission-rule"},{"title":"工具内置检查","href":"/zh/versions/2.0.6/building-blocks/permission-system/tool-check"}]},{"title":"中间件","href":"/zh/versions/2.0.6/building-blocks/middleware"},{"title":"RAG","href":"/zh/versions/2.0.6/building-blocks/rag"},{"title":"长期记忆","href":"/zh/versions/2.0.6/building-blocks/long-term-memory"},{"group":"工作区","pages":[{"title":"概述","href":"/zh/versions/2.0.6/building-blocks/workspace/overview"},{"title":"运行工作区","href":"/zh/versions/2.0.6/building-blocks/workspace/run-workspace"},{"title":"管理资源","href":"/zh/versions/2.0.6/building-blocks/workspace/manage-resources"},{"title":"MCP 网关","href":"/zh/versions/2.0.6/building-blocks/workspace/mcp-gateway"}]}]},{"group":"智能体即服务","pages":[{"title":"架构","href":"/zh/versions/2.0.6/deploy/agent-service"},{"title":"智能体团队","href":"/zh/versions/2.0.6/deploy/agent-team"},{"title":"资源共享","tag":"NEW","href":"/zh/versions/2.0.6/deploy/sharing"},{"title":"RAG 服务","href":"/zh/versions/2.0.6/deploy/rag"},{"title":"工作区管理","href":"/zh/versions/2.0.6/deploy/workspace-manager"},{"group":"MCP 与技能中心","tag":"NEW","pages":[{"title":"概览","href":"/zh/versions/2.0.6/deploy/hub/overview"},{"title":"MCP 中心","href":"/zh/versions/2.0.6/deploy/hub/mcp-hub"},{"title":"技能中心","href":"/zh/versions/2.0.6/deploy/hub/skill-hub"}]},{"group":"消息渠道","tag":"NEW","pages":[{"title":"概览","href":"/zh/versions/2.0.6/deploy/channel/overview"},{"title":"会话路由","href":"/zh/versions/2.0.6/deploy/channel/routing"},{"title":"飞书","href":"/zh/versions/2.0.6/deploy/channel/feishu"},{"title":"Discord","href":"/zh/versions/2.0.6/deploy/channel/discord"},{"title":"自定义渠道","href":"/zh/versions/2.0.6/deploy/channel/custom"}]},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"health","pages":[{"title":"Report service liveness and per-component readiness","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /health","href":"/api-reference/health/report-service-liveness-and-per-component-readiness"}]},{"group":"hub","pages":[{"title":"List Mcp Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp","href":"/api-reference/hub/list-mcp-hubs"},{"title":"List Mcp Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards","href":"/api-reference/hub/list-mcp-cards"},{"title":"Get Mcp Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/mcp/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-mcp-card"},{"title":"Install Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/mcp/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-mcp"},{"title":"List Skill Hubs","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill","href":"/api-reference/hub/list-skill-hubs"},{"title":"List Skill Cards","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards","href":"/api-reference/hub/list-skill-cards"},{"title":"Get Skill Card","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /hub/skill/{hub_id}/cards/{card_id}","href":"/api-reference/hub/get-skill-card"},{"title":"Install Skill","description":"Add a skill card to the user's library.\n\nMirrors the MCP install: user-level, no workspace involved. The\narchive is not downloaded here — only the card's metadata is\nrecorded, and the files are fetched when the skill is actually put\ninto a workspace. So a hub that has since dropped the card fails\nthen rather than now.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /hub/skill/{hub_id}/cards/{card_id}/install","href":"/api-reference/hub/install-skill"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"JSON Schema for the KB middleware's tunable parameters","description":"Return the parameter schema for\n:class:`agentscope.middleware.RAGMiddleware`.\n\nThe schema is shaped like every other ``parameter_schema`` served\nby this service — title / description / default / enum / minimum\n/ maximum — so the front-end can render the session-level KB\nattachment form with the same schema-driven component used for\nmodel parameters.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n\nReturns:\n `KbMiddlewareParametersSchemaResponse`:\n The JSON Schema describing the middleware's\n user-tunable parameters.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"}]},{"group":"mcp","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /mcp","href":"/api-reference/mcp/list-mcps"},{"title":"Delete Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /mcp/{mcp_id}","href":"/api-reference/mcp/delete-mcp"},{"title":"Update Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /mcp/{mcp_id}","href":"/api-reference/mcp/update-mcp"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"skill","pages":[{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill","href":"/api-reference/skill/list-skills"},{"title":"Get Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /skill/{skill_id}","href":"/api-reference/skill/get-skill"},{"title":"Delete Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /skill/{skill_id}","href":"/api-reference/skill/delete-skill"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Add Mcps From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/mcp/from-library","href":"/api-reference/workspace/add-mcps-from-library"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Upload Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/upload","href":"/api-reference/workspace/upload-skill"},{"title":"Add Skills From Library","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/skill/from-library","href":"/api-reference/workspace/add-skills-from-library"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"},{"title":"List Workspace Directory","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/directories","href":"/api-reference/workspace/list-workspace-directory"},{"title":"Create Download Token","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /workspace/files/download-token","href":"/api-reference/workspace/create-download-token"},{"title":"Read Workspace File","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /workspace/files","href":"/api-reference/workspace/read-workspace-file"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]},{"group":"embedding-model","pages":[{"title":"List all candidate embedding models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /embedding-model/","href":"/api-reference/embedding-model/list-all-candidate-embedding-models-under-the-given-credential-type"}]},{"group":"channels","pages":[{"title":"List Channel Types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/types","href":"/api-reference/channels/list-channel-types"},{"title":"List Channels","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/","href":"/api-reference/channels/list-channels"},{"title":"Create Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/","href":"/api-reference/channels/create-channel"},{"title":"Get Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}","href":"/api-reference/channels/get-channel"},{"title":"Delete Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json delete /channels/{channel_id}","href":"/api-reference/channels/delete-channel"},{"title":"Update Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json patch /channels/{channel_id}","href":"/api-reference/channels/update-channel"},{"title":"Enable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/enable","href":"/api-reference/channels/enable-channel"},{"title":"Disable Channel","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json post /channels/{channel_id}/disable","href":"/api-reference/channels/disable-channel"},{"title":"Channel Status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/status","href":"/api-reference/channels/channel-status"},{"title":"List Channel Sessions","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/sessions","href":"/api-reference/channels/list-channel-sessions"},{"title":"List Chat Ids","deprecated":null,"version":null,"openapi":"/en/versions/2.0.6/deploy/openapi.json get /channels/{channel_id}/chat_ids","href":"/api-reference/channels/list-chat-ids"}]}]}]},{"group":"其他","pages":[{"title":"常见问题","href":"/zh/versions/2.0.6/others/faq"},{"title":"版本迁移","href":"/zh/versions/2.0.6/others/change-log"}]}]},{"version":"2.0.5","groups":[{"group":"快速开始","pages":[{"title":"AgentScope 2.0 是什么?","href":"/zh/versions/2.0.5"},{"title":"快速开始","href":"/zh/versions/2.0.5/quickstart"},{"title":"更新日志","href":"/zh/versions/2.0.5/release-notes"}]},{"group":"核心模块","pages":[{"title":"消息与事件","href":"/zh/versions/2.0.5/building-blocks/message-and-event"},{"group":"智能体","pages":[{"title":"概述","href":"/zh/versions/2.0.5/building-blocks/agent/overview"},{"title":"配置智能体","href":"/zh/versions/2.0.5/building-blocks/agent/configure-agent"},{"title":"运行智能体","href":"/zh/versions/2.0.5/building-blocks/agent/run-agent"},{"title":"中断智能体","href":"/zh/versions/2.0.5/building-blocks/agent/interrupt-agent"},{"title":"人机交互","href":"/zh/versions/2.0.5/building-blocks/agent/human-in-the-loop"}]},{"group":"模型","pages":[{"title":"概述","href":"/zh/versions/2.0.5/building-blocks/model/overview"},{"title":"大语言模型","href":"/zh/versions/2.0.5/building-blocks/model/llm"},{"title":"语音合成","href":"/zh/versions/2.0.5/building-blocks/model/tts"},{"title":"嵌入模型","href":"/zh/versions/2.0.5/building-blocks/model/embedding"}]},{"group":"上下文管理","pages":[{"title":"概述","href":"/zh/versions/2.0.5/building-blocks/context/overview"},{"title":"感知环境","href":"/zh/versions/2.0.5/building-blocks/context/environment-awareness"},{"title":"压缩上下文","href":"/zh/versions/2.0.5/building-blocks/context/compress-context"},{"title":"卸载上下文","href":"/zh/versions/2.0.5/building-blocks/context/offload-context"}]},{"group":"工具","pages":[{"title":"概述","href":"/zh/versions/2.0.5/building-blocks/tool/overview"},{"title":"Python 函数工具","href":"/zh/versions/2.0.5/building-blocks/tool/python-tool"},{"title":"MCP","href":"/zh/versions/2.0.5/building-blocks/tool/mcp"},{"title":"Skill","href":"/zh/versions/2.0.5/building-blocks/tool/skill"},{"title":"元工具","href":"/zh/versions/2.0.5/building-blocks/tool/manage-tools"}]},{"title":"计划模式","href":"/zh/versions/2.0.5/building-blocks/plan"},{"group":"权限系统","pages":[{"title":"概述","href":"/zh/versions/2.0.5/building-blocks/permission-system/overview"},{"title":"权限模式","href":"/zh/versions/2.0.5/building-blocks/permission-system/permission-mode"},{"title":"权限规则","href":"/zh/versions/2.0.5/building-blocks/permission-system/permission-rule"},{"title":"工具内置检查","href":"/zh/versions/2.0.5/building-blocks/permission-system/tool-check"}]},{"title":"中间件","href":"/zh/versions/2.0.5/building-blocks/middleware"},{"title":"RAG","href":"/zh/versions/2.0.5/building-blocks/rag"},{"title":"长期记忆","href":"/zh/versions/2.0.5/building-blocks/long-term-memory"},{"group":"工作区","pages":[{"title":"概述","href":"/zh/versions/2.0.5/building-blocks/workspace/overview"},{"title":"运行工作区","href":"/zh/versions/2.0.5/building-blocks/workspace/run-workspace"},{"title":"管理资源","href":"/zh/versions/2.0.5/building-blocks/workspace/manage-resources"},{"title":"MCP 网关","href":"/zh/versions/2.0.5/building-blocks/workspace/mcp-gateway"}]}]},{"group":"智能体即服务","pages":[{"title":"架构","href":"/zh/versions/2.0.5/deploy/agent-service"},{"title":"智能体团队","href":"/zh/versions/2.0.5/deploy/agent-team"},{"title":"资源共享","tag":"NEW","href":"/zh/versions/2.0.5/deploy/sharing"},{"title":"RAG 服务","href":"/zh/versions/2.0.5/deploy/rag"},{"title":"工作区管理","tag":"NEW","href":"/zh/versions/2.0.5/deploy/workspace-manager"},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","description":"Replace the payload of an existing credential.\n\nArgs:\n credential_id (`str`): The credential to update.\n body (`UpdateCredentialRequest`): New credential payload.\n user_id (`str`): Injected authenticated user ID.\n storage (`StorageBase`): Injected storage backend.\n\nReturns:\n `CredentialRecord`: The updated credential record.\n\nRaises:\n `HTTPException`: 404 if the credential does not exist or does not\n belong to the authenticated user.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"JSON Schema for the KB middleware's tunable parameters","description":"Return the parameter schema for\n:class:`agentscope.middleware.RAGMiddleware`.\n\nThe schema is shaped like every other ``parameter_schema`` served\nby this service — title / description / default / enum / minimum\n/ maximum — so the front-end can render the session-level KB\nattachment form with the same schema-driven component used for\nmodel parameters.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n\nReturns:\n `KbMiddlewareParametersSchemaResponse`:\n The JSON Schema describing the middleware's\n user-tunable parameters.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]}]}]},{"group":"其他","pages":[{"title":"常见问题","href":"/zh/versions/2.0.5/others/faq"},{"title":"版本迁移","href":"/zh/versions/2.0.5/others/change-log"}]}]},{"version":"2.0.4","groups":[{"group":"快速开始","pages":[{"title":"AgentScope 2.0 是什么?","href":"/zh/versions/2.0.4"},{"title":"快速开始","href":"/zh/versions/2.0.4/quickstart"},{"title":"更新日志","href":"/zh/versions/2.0.4/release-notes"}]},{"group":"核心模块","pages":[{"title":"消息与事件","href":"/zh/versions/2.0.4/building-blocks/message-and-event"},{"title":"智能体","href":"/zh/versions/2.0.4/building-blocks/agent"},{"title":"模型","href":"/zh/versions/2.0.4/building-blocks/model"},{"title":"上下文管理","href":"/zh/versions/2.0.4/building-blocks/context"},{"title":"工具","href":"/zh/versions/2.0.4/building-blocks/tool"},{"title":"计划模式","href":"/zh/versions/2.0.4/building-blocks/plan"},{"title":"权限系统","href":"/zh/versions/2.0.4/building-blocks/permission-system"},{"title":"中间件","href":"/zh/versions/2.0.4/building-blocks/middleware"},{"title":"RAG","href":"/zh/versions/2.0.4/building-blocks/rag"},{"title":"长期记忆","href":"/zh/versions/2.0.4/building-blocks/long-term-memory"},{"title":"工作区","href":"/zh/versions/2.0.4/building-blocks/workspace"}]},{"group":"智能体即服务","pages":[{"title":"架构","href":"/zh/versions/2.0.4/deploy/agent-service"},{"title":"智能体团队","href":"/zh/versions/2.0.4/deploy/agent-team"},{"title":"RAG 服务","href":"/zh/versions/2.0.4/deploy/rag"},{"group":"API","pages":[{"group":"agent","pages":[{"title":"[Deprecated] Legacy sectioned schema — use /schema/v2","deprecated":true,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/[deprecated]-legacy-sectioned-schema-—-use-schemav2"},{"title":"Full AgentData JSON Schema for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /agent/schema/v2","href":"/api-reference/agent/full-agentdata-json-schema-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","description":"Replace the payload of an existing credential.\n\nArgs:\n credential_id (`str`): The credential to update.\n body (`UpdateCredentialRequest`): New credential payload.\n user_id (`str`): Injected authenticated user ID.\n storage (`StorageBase`): Injected storage backend.\n\nReturns:\n `CredentialRecord`: The updated credential record.\n\nRaises:\n `HTTPException`: 404 if the credential does not exist or does not\n belong to the authenticated user.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"JSON Schema for the KB middleware's tunable parameters","description":"Return the parameter schema for\n:class:`agentscope.middleware.RAGMiddleware`.\n\nThe schema is shaped like every other ``parameter_schema`` served\nby this service — title / description / default / enum / minimum\n/ maximum — so the front-end can render the session-level KB\nattachment form with the same schema-driven component used for\nmodel parameters.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n\nReturns:\n `KbMiddlewareParametersSchemaResponse`:\n The JSON Schema describing the middleware's\n user-tunable parameters.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"Interrupt a running or HITL-parked chat run for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json post /sessions/{session_id}/interrupt","href":"/api-reference/sessions/interrupt-a-running-or-hitl-parked-chat-run-for-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Probe the session's high-level status","deprecated":null,"version":null,"openapi":"/en/versions/2.0.4/deploy/openapi.json get /sessions/{session_id}/status","href":"/api-reference/sessions/probe-the-sessions-high-level-status"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]}]}]},{"group":"其他","pages":[{"title":"常见问题","href":"/zh/versions/2.0.4/others/faq"},{"title":"版本迁移","href":"/zh/versions/2.0.4/others/change-log"}]}]},{"version":"2.0.3","groups":[{"group":"快速开始","pages":[{"title":"AgentScope 2.0 是什么?","href":"/zh/versions/2.0.3"},{"title":"快速开始","href":"/zh/versions/2.0.3/quickstart"},{"title":"更新日志","href":"/zh/versions/2.0.3/release-notes"}]},{"group":"核心模块","pages":[{"title":"消息与事件","href":"/zh/versions/2.0.3/building-blocks/message-and-event"},{"title":"智能体","href":"/zh/versions/2.0.3/building-blocks/agent"},{"title":"模型","href":"/zh/versions/2.0.3/building-blocks/model"},{"title":"上下文管理","href":"/zh/versions/2.0.3/building-blocks/context"},{"title":"工具","href":"/zh/versions/2.0.3/building-blocks/tool"},{"title":"计划模式","href":"/zh/versions/2.0.3/building-blocks/plan"},{"title":"权限系统","href":"/zh/versions/2.0.3/building-blocks/permission-system"},{"title":"中间件","href":"/zh/versions/2.0.3/building-blocks/middleware"},{"title":"RAG","href":"/zh/versions/2.0.3/building-blocks/rag"},{"title":"长期记忆","href":"/zh/versions/2.0.3/building-blocks/long-term-memory"},{"title":"工作区","href":"/zh/versions/2.0.3/building-blocks/workspace"}]},{"group":"智能体即服务","pages":[{"title":"架构","href":"/zh/versions/2.0.3/deploy/agent-service"},{"title":"智能体团队","href":"/zh/versions/2.0.3/deploy/agent-team"},{"title":"RAG 服务","href":"/zh/versions/2.0.3/deploy/rag"},{"group":"API","pages":[{"group":"agent","pages":[{"title":"Get JSON Schema fragments for the agent form","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/schema","href":"/api-reference/agent/get-json-schema-fragments-for-the-agent-form"},{"title":"List all agents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /agent/","href":"/api-reference/agent/list-all-agents"},{"title":"Create a new agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /agent/","href":"/api-reference/agent/create-a-new-agent"},{"title":"Delete an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /agent/{agent_id}","href":"/api-reference/agent/delete-an-agent"},{"title":"Update an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /agent/{agent_id}","href":"/api-reference/agent/update-an-agent"}]},{"group":"chat","pages":[{"title":"Trigger a chat run (fire-and-forget)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /chat/","href":"/api-reference/chat/trigger-a-chat-run-fire-and-forget"}]},{"group":"credential","pages":[{"title":"List JSON schemas for all credential types","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/schemas","href":"/api-reference/credential/list-json-schemas-for-all-credential-types"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /credential/","href":"/api-reference/credential/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /credential/","href":"/api-reference/credential/create-a-new-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /credential/{credential_id}","href":"/api-reference/credential/delete-a-credential"},{"title":"Update a credential","description":"Replace the payload of an existing credential.\n\nArgs:\n credential_id (`str`): The credential to update.\n body (`UpdateCredentialRequest`): New credential payload.\n user_id (`str`): Injected authenticated user ID.\n storage (`StorageBase`): Injected storage backend.\n\nReturns:\n `CredentialRecord`: The updated credential record.\n\nRaises:\n `HTTPException`: 404 if the credential does not exist or does not\n belong to the authenticated user.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /credential/{credential_id}","href":"/api-reference/credential/update-a-credential"}]},{"group":"knowledge_bases","pages":[{"title":"List embedding models compatible with the KB dimension policy","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/embedding_models","href":"/api-reference/knowledge_bases/list-embedding-models-compatible-with-the-kb-dimension-policy"},{"title":"JSON Schema for the KB middleware's tunable parameters","description":"Return the parameter schema for\n:class:`agentscope.middleware.RAGMiddleware`.\n\nThe schema is shaped like every other ``parameter_schema`` served\nby this service — title / description / default / enum / minimum\n/ maximum — so the front-end can render the session-level KB\nattachment form with the same schema-driven component used for\nmodel parameters.\n\nArgs:\n _ (`str`):\n Injected authenticated user ID; only used to gate the\n endpoint behind authentication.\n\nReturns:\n `KbMiddlewareParametersSchemaResponse`:\n The JSON Schema describing the middleware's\n user-tunable parameters.","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/middleware/parameters_schema","href":"/api-reference/knowledge_bases/json-schema-for-the-kb-middlewares-tunable-parameters"},{"title":"List file types the configured parsers can ingest","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/supported_content_types","href":"/api-reference/knowledge_bases/list-file-types-the-configured-parsers-can-ingest"},{"title":"List the caller's knowledge bases","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/","href":"/api-reference/knowledge_bases/list-the-callers-knowledge-bases"},{"title":"Create a new knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/","href":"/api-reference/knowledge_bases/create-a-new-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/delete-a-knowledge-base"},{"title":"Update mutable fields on a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json patch /knowledge_bases/{knowledge_base_id}","href":"/api-reference/knowledge_bases/update-mutable-fields-on-a-knowledge-base"},{"title":"List documents registered in a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/list-documents-registered-in-a-knowledge-base"},{"title":"Upload a document into a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge_bases/upload-a-document-into-a-knowledge-base"},{"title":"Batch-query indexing status of one or more documents","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /knowledge_bases/{knowledge_base_id}/documents/status","href":"/api-reference/knowledge_bases/batch-query-indexing-status-of-one-or-more-documents"},{"title":"Delete a document from a knowledge base","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json delete /knowledge_bases/{knowledge_base_id}/documents/{document_id}","href":"/api-reference/knowledge_bases/delete-a-document-from-a-knowledge-base"},{"title":"Search a knowledge base by natural-language query","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json post /knowledge_bases/{knowledge_base_id}/search","href":"/api-reference/knowledge_bases/search-a-knowledge-base-by-natural-language-query"}]},{"group":"schedule","pages":[{"title":"List all schedules","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/","href":"/api-reference/schedule/list-all-schedules"},{"title":"Create a new schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /schedule/","href":"/api-reference/schedule/create-a-new-schedule"},{"title":"Delete a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /schedule/{schedule_id}","href":"/api-reference/schedule/delete-a-schedule"},{"title":"Update a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /schedule/{schedule_id}","href":"/api-reference/schedule/update-a-schedule"},{"title":"List execution sessions for a schedule","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /schedule/{schedule_id}/sessions","href":"/api-reference/schedule/list-execution-sessions-for-a-schedule"}]},{"group":"sessions","pages":[{"title":"List sessions for an agent","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/","href":"/api-reference/sessions/list-sessions-for-an-agent"},{"title":"Create a new session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /sessions/","href":"/api-reference/sessions/create-a-new-session"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /sessions/{session_id}","href":"/api-reference/sessions/delete-a-session"},{"title":"Update a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json patch /sessions/{session_id}","href":"/api-reference/sessions/update-a-session"},{"title":"List messages for a session","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/messages","href":"/api-reference/sessions/list-messages-for-a-session"},{"title":"Subscribe to a session's event stream (SSE)","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /sessions/{session_id}/stream","href":"/api-reference/sessions/subscribe-to-a-sessions-event-stream-sse"}]},{"group":"workspace","pages":[{"title":"List Mcps","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/mcp","href":"/api-reference/workspace/list-mcps"},{"title":"Add Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/mcp","href":"/api-reference/workspace/add-mcp"},{"title":"Remove Mcp","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/mcp/{mcp_name}","href":"/api-reference/workspace/remove-mcp"},{"title":"List Skills","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /workspace/skill","href":"/api-reference/workspace/list-skills"},{"title":"Add Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json post /workspace/skill","href":"/api-reference/workspace/add-skill"},{"title":"Remove Skill","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json delete /workspace/skill/{skill_name}","href":"/api-reference/workspace/remove-skill"}]},{"group":"model","pages":[{"title":"List all candidate models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.2/deploy/openapi.json get /model/","href":"/api-reference/model/list-all-candidate-models-under-the-given-credential-type"}]},{"group":"tts-model","pages":[{"title":"List all candidate TTS models under the given credential type","deprecated":null,"version":null,"openapi":"/en/versions/2.0.3/deploy/openapi.json get /tts-model/","href":"/api-reference/tts-model/list-all-candidate-tts-models-under-the-given-credential-type"}]}]}]},{"group":"其他","pages":[{"title":"常见问题","href":"/zh/versions/2.0.3/others/faq"},{"title":"版本迁移","href":"/zh/versions/2.0.3/others/change-log"}]}]},{"version":"2.0.2","pages":[{"title":"2.0.2","href":"/zh/versions/2.0.2"}]}]},{"tab":"ReMe","versions":[{"version":"latest","groups":[{"group":"快速开始","pages":[{"title":"什么是 ReMe?","href":"/zh/reme/latest/overview"},{"title":"快速开始","href":"/zh/reme/latest/quickstart"},{"title":"核心概念","href":"/zh/reme/latest/concepts"}]},{"group":"集成","pages":[{"title":"概览","href":"/zh/reme/latest/integration/overview"},{"title":"部署","href":"/zh/reme/latest/integration/deployment"},{"title":"Python SDK","href":"/zh/reme/latest/integration/python-sdk"},{"title":"Agent 集成","href":"/zh/reme/latest/integration/plugins"}]},{"group":"资源","pages":[{"title":"参考","href":"/zh/reme/latest/reference"},{"title":"FAQ","href":"/zh/reme/latest/faq"},{"title":"贡献","href":"/zh/reme/latest/contribution"}]}]}]}]}]},"basePath":"","title":"List embedding models compatible with the KB dimension policy - AgentScope","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}