The snippet below builds the minimal agent: a DashScope credential, the matching chat model, an empty toolkit, and an Agent. The agent exposes two entry points — reply returns the final message, while reply_stream yields incremental events as the agent reasons and acts.
import asyncioimport osfrom agentscope.agent import Agentfrom agentscope.credential import DashScopeCredentialfrom agentscope.event import EventTypefrom agentscope.message import UserMsgfrom agentscope.model import DashScopeChatModelfrom agentscope.tool import Toolkit, Bash, Read, Write, Editasync def main() -> None: agent = Agent( name="Friday", system_prompt="You are a helpful assistant named Friday.", model=DashScopeChatModel( credential=DashScopeCredential( api_key=os.getenv("DASHSCOPE_API_KEY"), ), model="qwen-plus", ), toolkit=Toolkit(tools=[Bash(), Read(), Write(), Edit()]), ) user_msg = UserMsg(name="user", content="Hello, who are you?") # Option 1: await the final assistant message. reply_msg = await agent.reply(user_msg) # `reply_msg` is an `AssistantMsg` whose `content` is a list of blocks. # Inspect text blocks, tool calls, etc. as needed. ... # Option 2: stream incremental events (text deltas, tool calls, ...). async for event in agent.reply_stream(user_msg): # Dispatch on `event.type` — each branch handles one event kind. match event.type: case EventType.TEXT_BLOCK_DELTA: # Streaming text chunk from the model — append to UI / stdout. ... case EventType.TOOL_CALL_START: # The agent is about to invoke a tool — surface the call. ... case _: # Other events: thinking blocks, tool results, reply end, ... ...asyncio.run(main())
Set DASHSCOPE_API_KEY in your environment before running the script. To use a different provider, swap DashScopeCredential and DashScopeChatModel for the matching pair (e.g. OpenAICredential and OpenAIChatModel).
To satisfy the requirements of different functionalities, AgentScope provides extra dependencies that can be installed based on your needs.
full: including extra dependencies for model APIs, tool functions and more.
dev: development dependencies, including testing and documentation tools.
For example, when installing the full dependencies, the installation command varies depending on your operating system.
For Windows users:
uv pip install "agentscope[full]==2.0.11"
For Mac and Linux users:
uv pip install "agentscope[full]==2.0.11"
{"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":""},"chroma":{"liveDeploymentHistoryId":"6acf927233db61125561fb77","collectionId":"7ac31d24-f1ab-45c3-85f4-86092cf1e1b6","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6acf927233db61125561fb77"},"entitlements":{},"buildId":"6ae020fa971f41769d3546e9","clientVersion":"0.0.3971","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":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"en/versions/2.0.11/quickstart","slug":"/en/versions/2.0.11/quickstart","pageMetadata":{"title":"Quickstart","description":"Get up and running with AgentScope 2.0 in minutes","href":"/en/versions/2.0.11/quickstart"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get up and running with AgentScope 2.0 in minutes\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Tip}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`installation`,children:`Installation`}),`\n`,_jsx(_components.p,{children:`AgentScope requires Python 3.11+, and you can install it from PyPI or from source.`}),`\n`,_jsxs(_components.p,{children:[`It’s recommended to install AgentScope by using `,_jsx(_components.a,{href:`https://github.com/astral-sh/uv`,children:`uv`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`from-pypi`,children:`From PyPI`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`uv`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` pip`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"agentscope==2.0.11\"`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`from-source`,children:`From Source`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`4`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`git`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` clone`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -b`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` main`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` https://github.com/agentscope-ai/agentscope`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`cd`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` agentscope`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`git`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` checkout`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` 8af9d25784e704a4b11d71bd673257c68505fcb8`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`uv`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` pip`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -e`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` .`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`verify-installation`,children:`Verify Installation`}),`\n`,_jsx(_components.p,{children:`To ensure AgentScope is installed successfully, check via executing the following code:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`3`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` agentscope`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#DCDCAA`},children:`print`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(agentscope.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:`__version__`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`your-first-agent`,children:`Your First Agent`}),`\n`,_jsxs(_components.p,{children:[`The snippet below builds the minimal agent: a DashScope credential, the matching chat model, an empty toolkit, and an `,_jsx(_components.code,{children:`Agent`}),`. The agent exposes two entry points — `,_jsx(_components.code,{children:`reply`}),` returns the final message, while `,_jsx(_components.code,{children:`reply_stream`}),` yields incremental events as the agent reasons and acts.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`48`,language:`python`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`python`,children:_jsxs(_components.code,{language:`python`,numberOfLines:`48`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` asyncio`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` os`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` agentscope.agent `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Agent`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` agentscope.credential `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` DashScopeCredential`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` agentscope.event `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` EventType`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` agentscope.message `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` UserMsg`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` agentscope.model `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` DashScopeChatModel`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`from`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` agentscope.tool `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`import`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Toolkit, Bash, Read, Write, Edit`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`async`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:` def`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` main`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`() -> `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`None`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` agent `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` Agent(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` name`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Friday\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` system_prompt`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"You are a helpful assistant named Friday.\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` model`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`DashScopeChatModel(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` credential`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`DashScopeCredential(`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` api_key`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`os.getenv(`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"DASHSCOPE_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`),`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ),`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` model`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"qwen-plus\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ),`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:` toolkit`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`Toolkit(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`tools`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`[Bash(), Read(), Write(), Edit()]),`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` )`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` user_msg `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` UserMsg(`}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`name`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"user\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#9CDCFE`},children:`content`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"Hello, who are you?\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`)`})]}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Option 1: await the final assistant message.`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` reply_msg `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` agent.reply(user_msg)`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:\" # `reply_msg` is an `AssistantMsg` whose `content` is a list of blocks.\"})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Inspect text blocks, tool calls, etc. as needed.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:` ...`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Option 2: stream incremental events (text deltas, tool calls, ...).`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` async`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` for`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` event `}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:`in`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` agent.reply_stream(user_msg):`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:\" # Dispatch on `event.type` — each branch handles one event kind.\"})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` match`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` event.type:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` case`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` EventType.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:`TEXT_BLOCK_DELTA`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Streaming text chunk from the model — append to UI / stdout.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:` ...`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` case`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` EventType.`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:`TOOL_CALL_START`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # The agent is about to invoke a tool — surface the call.`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:` ...`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` case`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` _:`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#6E7781`,\"--shiki-dark\":`#6A9955`},children:` # Other events: thinking blocks, tool results, reply end, ...`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#D4D4D4`},children:` ...`})}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`asyncio.run(main())`})}),`\n`]})})}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Set `,_jsx(_components.code,{children:`DASHSCOPE_API_KEY`}),` in your environment before running the script. To use a different provider, swap `,_jsx(_components.code,{children:`DashScopeCredential`}),` and `,_jsx(_components.code,{children:`DashScopeChatModel`}),` for the matching pair (e.g. `,_jsx(_components.code,{children:`OpenAICredential`}),` and `,_jsx(_components.code,{children:`OpenAIChatModel`}),`).`]})}),`\n`,_jsx(Heading,{level:`2`,id:`extra-dependencies`,children:`Extra Dependencies`}),`\n`,_jsx(_components.p,{children:`To satisfy the requirements of different functionalities, AgentScope provides extra dependencies that can be installed based on your needs.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`full`}),`: including extra dependencies for model APIs, tool functions and more.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`dev`}),`: development dependencies, including testing and documentation tools.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`For example, when installing the full dependencies, the installation command varies depending on your operating system.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`For Windows users:`}),`\n`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`uv`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` pip`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"agentscope[full]==2.0.11\"`})]}),`\n`]})})}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`For Mac and Linux users:`}),`\n`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`shellscript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`uv`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` pip`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` install`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"agentscope[full]==2.0.11\"`})]}),`\n`]})})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Quickstart","description":"Get up and running with AgentScope 2.0 in minutes","href":"/en/versions/2.0.11/quickstart"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Installation","slug":"installation","depth":2,"children":[{"title":"From PyPI","slug":"from-pypi","depth":3,"children":[]},{"title":"From Source","slug":"from-source","depth":3,"children":[]},{"title":"Verify Installation","slug":"verify-installation","depth":3,"children":[]}]},{"title":"Your First Agent","slug":"your-first-agent","depth":2,"children":[]},{"title":"Extra Dependencies","slug":"extra-dependencies","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"agentscope-ai-786677c7","siteName":"AgentScope","title":"Quickstart - AgentScope","navMaps":{"firstHrefInVersion":{"2.0.12dev":{"href":"/en/versions/2.0.12dev/quickstart","matchLevel":1},"2.0.11":{"href":"/en/versions/2.0.11/quickstart","matchLevel":0},"2.0.10":{"href":"/en/versions/2.0.10/quickstart","matchLevel":1},"2.0.9":{"href":"/en/versions/2.0.9/quickstart","matchLevel":1},"2.0.8":{"href":"/en/versions/2.0.8/quickstart","matchLevel":1},"2.0.7":{"href":"/en/versions/2.0.7/quickstart","matchLevel":1},"2.0.6":{"href":"/en/versions/2.0.6/quickstart","matchLevel":1},"2.0.5":{"href":"/en/versions/2.0.5/quickstart","matchLevel":1},"2.0.4":{"href":"/en/versions/2.0.4/quickstart","matchLevel":1},"2.0.3":{"href":"/en/versions/2.0.3/quickstart","matchLevel":1},"2.0.2":{"href":"/en/versions/2.0.2/quickstart","matchLevel":1},"1.0.21":{"href":"/en/versions/1.0.21/quickstart","matchLevel":1},"latest":{"href":"/en/reme/latest/overview","matchLevel":4}},"firstHrefInLanguage":{"en":{"href":"/en/versions/2.0.11/quickstart","matchLevel":0},"zh":{"href":"/zh/versions/2.0.11/quickstart","matchLevel":1}}},"lastModified":"2026-10-27T03:57:37.468Z","originalFileLocation":"en/versions/2.0.11/quickstart.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=\"Get up and running with AgentScope 2.0 in minutes\">\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=\"Quickstart - AgentScope\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get up and running with AgentScope 2.0 in minutes\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AgentScope\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.agentscope.io/en/versions/2.0.11/quickstart\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://agentscope-ai-786677c7.mintlify.app/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Quickstart\u0026amp;description=Get+up+and+running+with+AgentScope+2.0+in+minutes\u0026amp;theme=010675907e6e5009270e69a1\u0026amp;signature=7ddb5421eede5f914c9de330276a480fc9c9fd3729faa7d62031ba2ee76cef78\">\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=\"Quickstart - AgentScope\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get up and running with AgentScope 2.0 in minutes\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://agentscope-ai-786677c7.mintlify.app/_mintlify/api/og/v2?division=Get+Started\u0026amp;title=Quickstart\u0026amp;description=Get+up+and+running+with+AgentScope+2.0+in+minutes\u0026amp;theme=010675907e6e5009270e69a1\u0026amp;signature=7ddb5421eede5f914c9de330276a480fc9c9fd3729faa7d62031ba2ee76cef78\">\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/en/versions/2.0.11/quickstart\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/versions/2.0.11/quickstart.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.agentscope.io/en/versions/2.0.11/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.agentscope.io/zh/versions/2.0.11/quickstart\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.agentscope.io/en/versions/2.0.11/quickstart\">\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/en/versions/2.0.11/quickstart#webpage\",\"url\":\"https://docs.agentscope.io/en/versions/2.0.11/quickstart\",\"name\":\"Quickstart\",\"description\":\"Get up and running with AgentScope 2.0 in minutes\",\"dateModified\":\"2026-10-27T03:57:37.468Z\",\"isPartOf\":{\"@id\":\"https://docs.agentscope.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.agentscope.io/en/versions/2.0.11/quickstart#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.agentscope.io/en/versions/2.0.11/quickstart#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Get Started\",\"item\":\"https://docs.agentscope.io/en/versions/2.0.11/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Quickstart\",\"item\":\"https://docs.agentscope.io/en/versions/2.0.11/quickstart\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.agentscope.io/en/versions/2.0.11/quickstart#article\",\"headline\":\"Quickstart\",\"name\":\"Quickstart\",\"description\":\"Get up and running with AgentScope 2.0 in minutes\",\"url\":\"https://docs.agentscope.io/en/versions/2.0.11/quickstart\",\"mainEntityOfPage\":{\"@id\":\"https://docs.agentscope.io/en/versions/2.0.11/quickstart#webpage\"},\"dateModified\":\"2026-10-27T03:57:37.468Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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","pages":[{"title":"2.0.12dev","href":"/en/versions/2.0.12dev/quickstart"}]},{"version":"2.0.11","default":true,"groups":[{"group":"Get Started","pages":[{"title":"What's AgentScope 2.0?","description":"Secure, efficient, flexible, and complete.","href":"/en/versions/2.0.11"},{"title":"Quickstart","href":"/en/versions/2.0.11/quickstart"},{"title":"Release Notes","description":"Version history of AgentScope 2.x, including new features, changes, and bug fixes grouped by module for each release.","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","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","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","pages":[{"title":"2.0.10","href":"/en/versions/2.0.10/quickstart"}]},{"version":"2.0.9","pages":[{"title":"2.0.9","href":"/en/versions/2.0.9/quickstart"}]},{"version":"2.0.8","pages":[{"title":"2.0.8","href":"/en/versions/2.0.8/quickstart"}]},{"version":"2.0.7","pages":[{"title":"2.0.7","href":"/en/versions/2.0.7/quickstart"}]},{"version":"2.0.6","pages":[{"title":"2.0.6","href":"/en/versions/2.0.6/quickstart"}]},{"version":"2.0.5","pages":[{"title":"2.0.5","href":"/en/versions/2.0.5/quickstart"}]},{"version":"2.0.4","pages":[{"title":"2.0.4","href":"/en/versions/2.0.4/quickstart"}]},{"version":"2.0.3","pages":[{"title":"2.0.3","href":"/en/versions/2.0.3/quickstart"}]},{"version":"2.0.2","pages":[{"title":"2.0.2","href":"/en/versions/2.0.2/quickstart"}]},{"version":"1.0.21","pages":[{"title":"1.0.21","href":"/en/versions/1.0.21/quickstart"}]}]},{"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","pages":[{"title":"zh","href":"/zh/versions/2.0.11/quickstart"}]}]},"title":"Quickstart - AgentScope","buildId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","deploymentId":"dpl_DFJrtvUi8HS5F9nkooKuDJsuD5BM","dynamics":[],"chunks":[]}