Skip to main content

概览

OpenAI 兼容 API 的 Endpoint、认证方式和可用接口。

前提条件

  1. 已开通阿里云百炼,并创建 API Key。
  2. 已获取工作空间 ID(ws_xxxxxxxxxxxx)。

Endpoint

https://{workspace_id}.cn-beijing.maas.aliyuncs.com/compatible-mode/v1
  • workspace_id:工作空间 ID。
  • 当前地域为 cn-beijing。
  • 将 {workspace_id} 替换为实际工作空间 ID。
  • 请求路径拼接在 Base URL 之后,例如 POST {Base URL}/agents。

认证

全部请求通过 HTTP Header 携带 API Key:
Authorization: Bearer $DASHSCOPE_API_KEY
兼容客户端可以同时发送 OpenAI-Beta: agents=v1;该接口不依赖该 Header 选择默认值。鉴权、工作空间路由和权限配置见认证。

可用 API

资源端点用途
AgentPOST /agents创建可复用 Agent
GET /agents/{agent_id}获取 Agent
GET /agents列出 Agent
POST /agents/{agent_id}更新 Agent
DELETE /agents/{agent_id}删除 Agent
SessionPOST /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
EventPOST /agents/sessions/{session_id}/events提交消息、取消或工具结果
GET /agents/sessions/{session_id}/events订阅实时 SSE 事件流
HistoryGET /agents/sessions/{session_id}/turns查询 Turn
GET /agents/sessions/{session_id}/items查询 Item
GET /agents/sessions/{session_id}/subagents查询子 Agent
EnvironmentPOST /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}删除环境模板
FilePOST /agents/file上传源文件
GET /agents/file列出源文件
GET /agents/file/{file_id}获取源文件
DELETE /agents/file/{file_id}删除源文件
POST /agents/environments/{environment_id}/files将源文件写入环境
ArtifactGET /agents/sessions/{session_id}/artifacts查询产物
GET /agents/sessions/{session_id}/artifacts/{artifact_id}/content下载产物
VaultPOST /vaults创建 Vault
POST /vaults/{vault_id}/credentials创建 Credential
上表是常用接口示例,不是完整清单;完整接口见左侧导航。

SDK 安装

安装 OpenAI Python SDK:
pip install openai requests
调用示例见快速开始。