OpenAI 兼容 API 的 Endpoint、认证方式和可用接口。
前提条件
- 已开通阿里云百炼,并创建 API Key。
- 已获取工作空间 ID(
ws_xxxxxxxxxxxx)。
Endpoint
workspace_id:工作空间 ID。- 当前地域为
cn-beijing。 - 将
{workspace_id}替换为实际工作空间 ID。 - 请求路径拼接在 Base URL 之后,例如
POST {Base URL}/agents。
认证
全部请求通过 HTTP Header 携带 API Key:
OpenAI-Beta: agents=v1;该接口不依赖该 Header 选择默认值。鉴权、工作空间路由和权限配置见认证。
可用 API
| 资源 | 端点 | 用途 |
|---|---|---|
| Agent | POST /agents | 创建可复用 Agent |
GET /agents/{agent_id} | 获取 Agent | |
GET /agents | 列出 Agent | |
POST /agents/{agent_id} | 更新 Agent | |
DELETE /agents/{agent_id} | 删除 Agent | |
| Session | POST /agents/sessions | 创建 Session 并提交首轮输入 |
GET /agents/sessions | 列出 Session | |
GET /agents/sessions/{session_id} | 获取 Session | |
POST /agents/sessions/{session_id} | 更新 Session 配置 | |
DELETE /agents/sessions/{session_id} | 删除 Session | |
| Event | POST /agents/sessions/{session_id}/events | 提交消息、取消或工具结果 |
GET /agents/sessions/{session_id}/events | 订阅实时 SSE 事件流 | |
| History | GET /agents/sessions/{session_id}/turns | 查询 Turn |
GET /agents/sessions/{session_id}/items | 查询 Item | |
GET /agents/sessions/{session_id}/subagents | 查询子 Agent | |
| Environment | POST /agents/environments | 创建托管环境 |
GET /agents/environments/{environment_id} | 获取环境 | |
GET /agents/environments | 列出环境 | |
GET /agents/environments/templates | 列出环境模板 | |
GET /agents/environments/templates/{template_id} | 获取环境模板 | |
POST /agents/environments/templates | 创建环境模板 | |
POST /agents/environments/templates/{template_id} | 更新环境模板 | |
DELETE /agents/environments/templates/{template_id} | 删除环境模板 | |
| File | POST /agents/file | 上传源文件 |
GET /agents/file | 列出源文件 | |
GET /agents/file/{file_id} | 获取源文件 | |
DELETE /agents/file/{file_id} | 删除源文件 | |
POST /agents/environments/{environment_id}/files | 将源文件写入环境 | |
| Artifact | GET /agents/sessions/{session_id}/artifacts | 查询产物 |
GET /agents/sessions/{session_id}/artifacts/{artifact_id}/content | 下载产物 | |
| Vault | POST /vaults | 创建 Vault |
POST /vaults/{vault_id}/credentials | 创建 Credential |