Skip to content

docs: link the Agents API and Core API rows in the README #264

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
SaladDay merged 1 commit into from
Sep 30, 2026
Merged

docs: link the Agents API and Core API rows in the README #264

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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ Core exposes two APIs:

| API | Path | Used by |
| --- | --- | --- |
| **Agents API** | `/v1` | Your applications. Same protocol as OpenAI's |
| **Core API** | `/core/v1` | Operators, through Web |
| **[Agents API](docs/api/public-agent-api.md)** | `/v1` | Your applications. Same protocol as [OpenAI's Agents API](https://developers.openai.com/api/docs/guides/agents-api/overview) |
| **[Core API](docs/api/README.md#core-api)** | `/core/v1` | Operators, through Web |

Core keeps all state. The Runtime runs the chosen harness inside the Environment.
Each connection is a defined protocol, so any part can be replaced on its own. See
Expand Down
4 changes: 2 additions & 2 deletions README.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ Core 对外提供两组 API：

| API | 路径 | 调用方 |
| --- | --- | --- |
| **Agents API** | `/v1` | 你的应用，与 OpenAI 协议一致 |
| **Core API** | `/core/v1` | 管理员，通过 Web 调用 |
| **[Agents API](docs/api/public-agent-api.md)** | `/v1` | 你的应用，与 [OpenAI 的 Agents API](https://developers.openai.com/api/docs/guides/agents-api/overview) 协议一致 |
| **[Core API](docs/api/README.md#core-api)** | `/core/v1` | 管理员，通过 Web 调用 |

所有状态都由 Core 保存；Runtime 在 Environment 中运行所选 Harness。各部件之间都通过既定协议连接，
任何一个都可以单独替换。详见[架构说明](docs/architecture.md)。
Expand Down