Skip to content

docs: hotfix webui doc #420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AgentScopeTeam merged 1 commit into from
Jan 26, 2026
Merged

docs: hotfix webui doc #420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions cookbook/en/webui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
In **WebUI**, there are mainly three ways to call an Agent:
Comment thread
AgentScopeTeam marked this conversation as resolved.

1. **Use the [hosted WebUI](http://webui.runtime.agentscope.io/) (recommended, no installation)**
2. **Start directly using `npx`**
3. **Install locally and start the development environment**
2. **Start the Agent in Python and enable the WebUI**
3. **Start directly using `npx`**
4. **Install locally and start the development environment**
Comment thread
AgentScopeTeam marked this conversation as resolved.

Before you begin, we assume you have already **deployed your Agent**.
For example, if it’s deployed at `localhost:8090`, the WebUI will call it via the `process` endpoint, so the full request URL will be: http://localhost:8090/process
Expand All @@ -25,7 +26,7 @@ http://localhost:8090/process

## Method 2: Start the Agent Directly in Python and Enable the WebUI

This approach is suitable for running the Agent directly in a Python environment and enabling the built‑in WebUI. You only need to ensure that the Agent's required model environment has been deployed and that the API key is properly configured.
This approach is suitable for running the Agent directly in a Python environment and enabling the built‑in WebUI. You only need to ensure that the Agent's required environment and API key have been properly configured.

```python
from agentscope_runtime.engine import AgentApp
Expand Down
7 changes: 4 additions & 3 deletions cookbook/zh/webui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
在 **WebUI** 中，主要有三种方式调用 Agent：
Comment thread
AgentScopeTeam marked this conversation as resolved.

1. **使用 [托管版 WebUI](http://webui.runtime.agentscope.io/)（推荐，无需安装）**
2. **直接使用 `npx` 启动**
3. **本地安装并启动开发环境**
2. **在 Python 中直接启动 Agent 并启用 WebUI**
3. **直接使用 `npx` 启动**
4. **本地安装并启动开发环境**
Comment thread
AgentScopeTeam marked this conversation as resolved.

在开始之前，我们假设你已经**部署好了 Agent**。
例如，如果部署在 `localhost:8090`，WebUI 会通过 `process` 端点调用它，因此完整请求 URL 为： http://localhost:8090/process
Expand All @@ -25,7 +26,7 @@ http://localhost:8090/process

## 方法 2：在 Python 中直接启动 Agent 并启用 WebUI

这种方式适合在 Python 环境中直接运行 Agent，并启用内置 WebUI。你只需要确保 Agent 所需的模型环境已部署，并且 API Key 已正确配置。
这种方式适合在 Python 环境中直接运行 Agent，并启用内置 WebUI。你只需要确保 Agent 所需的环境、 API Key已正确配置。
Comment thread
AgentScopeTeam marked this conversation as resolved.
Comment thread
AgentScopeTeam marked this conversation as resolved.

```python
from agentscope_runtime.engine import AgentApp
Expand Down