Skip to content

Commit bc39aef

Browse files
committed
docs: move README architecture sections earlier
1 parent 0ed0a54 commit bc39aef

2 files changed

Lines changed: 26 additions & 26 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,19 @@ OpenAgentCore runs AI agents on your own infrastructure behind the OpenAI Agents
2121
- **Your choice of machine.** Agents work in a managed sandbox (Docker, microsandbox or E2B), or on your own Linux, macOS or Windows machine.
2222
- **Every part is replaceable.** Sandboxes, harnesses and model providers plug in through defined protocols.
2323

24+
## How it fits together
25+
26+
![OpenAgentCore architecture](docs/assets/architecture.png)
27+
28+
Applications and operators use these Core APIs:
29+
30+
| API | Path | Used by |
31+
| --- | --- | --- |
32+
| **[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) |
33+
| **[Core API](contracts/agents-api/admin-api.md)** | `/core/v1` | Operators, through Web |
34+
35+
Core keeps durable execution 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 the [architecture guide](docs/architecture.md).
36+
2437
## Screenshots
2538

2639
| Overview | Agent metrics |
@@ -44,19 +57,6 @@ Then:
4457

4558
The [installation guide](docs/getting-started/install.md) covers each step, HTTPS and a quick local trial. Listen addresses, ports and other options: [installation options](docs/getting-started/install-options.md).
4659

47-
## How it fits together
48-
49-
![OpenAgentCore architecture](docs/assets/architecture.png)
50-
51-
Applications and operators use these Core APIs:
52-
53-
| API | Path | Used by |
54-
| --- | --- | --- |
55-
| **[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) |
56-
| **[Core API](contracts/agents-api/admin-api.md)** | `/core/v1` | Operators, through Web |
57-
58-
Core keeps durable execution 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 the [architecture guide](docs/architecture.md).
59-
6060
## Documentation
6161

6262
| I want to | Start with |

‎README.zh-CN.md‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,19 @@ OpenAI Agents API 的开源实现,支持多种原生执行引擎,可部署
1212

1313
</div>
1414

15+
## 组件关系
16+
17+
![OpenAgentCore 架构](docs/assets/architecture.png)
18+
19+
应用和管理员使用以下 Core API:
20+
21+
| API | 路径 | 调用方 |
22+
| --- | --- | --- |
23+
| **[Agents API](docs/api/public-agent-api.md)** | `/v1` | 你的应用,与 [OpenAI 的 Agents API](https://developers.openai.com/api/docs/guides/agents-api/overview) 协议一致 |
24+
| **[Core API](contracts/agents-api/admin-api.md)** | `/core/v1` | 管理员,通过 Web 调用 |
25+
26+
持久化执行状态由 Core 保存;Runtime 在 Environment 中运行所选 Harness。各部件之间都通过既定协议连接, 任何一个都可以单独替换。详见[架构说明](docs/architecture.md)。
27+
1528
## 这是什么
1629

1730
OpenAgentCore 在你自己的基础设施上运行 AI Agent,对外提供 OpenAI Agents API。
@@ -44,19 +57,6 @@ curl -fsSL https://github.com/MiniMax-AI/OpenAgentCore/releases/latest/download/
4457

4558
[安装指南](docs/getting-started/install.md)详细介绍每一步,以及 HTTPS 配置和本地快速试用。监听地址、端口等参数见[安装配置选项](docs/getting-started/install-options.md)。
4659

47-
## 组件关系
48-
49-
![OpenAgentCore 架构](docs/assets/architecture.png)
50-
51-
应用和管理员使用以下 Core API:
52-
53-
| API | 路径 | 调用方 |
54-
| --- | --- | --- |
55-
| **[Agents API](docs/api/public-agent-api.md)** | `/v1` | 你的应用,与 [OpenAI 的 Agents API](https://developers.openai.com/api/docs/guides/agents-api/overview) 协议一致 |
56-
| **[Core API](contracts/agents-api/admin-api.md)** | `/core/v1` | 管理员,通过 Web 调用 |
57-
58-
持久化执行状态由 Core 保存;Runtime 在 Environment 中运行所选 Harness。各部件之间都通过既定协议连接, 任何一个都可以单独替换。详见[架构说明](docs/architecture.md)。
59-
6060
## 文档
6161

6262
| 我想要 | 从这里开始 |

0 commit comments

Comments
 (0)