Skip to main content
AGENT API 是咏唱引擎基于 OpenAI codex harness 构建的分层智能体平台,对外暴露 OpenAI Agents API。你可以创建智能体、管理会话,并把状态持久化到 Postgres;context_fragments 按主体存放,由 pgvector 支撑。直接调 API 也行,用 SDK 也行:Python、Rust、Swift、Kotlin 与 TypeScript 的 SDK 形态都与 OpenAI Agents SDK 一致。

认证

Bearer 与 ApiKey 两种方案,密钥可自助管理

创建智能体

使用模型、指令与工具创建智能体

创建会话

为已有智能体启动会话并追踪状态

API 密钥

创建、列出并吊销 API 密钥

基础 URL

海外站点请使用 https://agent.ariacompute.com。

认证

用下面任一方案,在 Authorization 头里传 API 密钥:
  • Authorization: Bearer <api_key>
  • Authorization: ApiKey <key>
解析顺序与云端服务一致:
  1. 出示的密钥等于 AGENT_CLOUD_API_KEY → 引导 Admin 主体。
  2. 否则按 sha256 在 api_keys 表中查找。
  3. 未出示密钥:已设置 AGENT_CLOUD_API_KEY 就返回 401;未设置则以 开放模式 运行,主体是 default 租户。
自助密钥在 /v1/api-keys 上管理,需要 admin 作用域。

错误格式

错误返回 HTTP 状态码,外加 OpenAI 形态的 JSON 响应体;响应体里还有一个扁平的 message 字段,用于兼容 Aria 客户端:

语言绑定

AGENT API 提供 Python、Rust、Swift、Kotlin 与 TypeScript 的 SDK,形态都与 OpenAI Agents SDK 一致。

版本管理

当前接口以 /v1 为前缀,形态遵循 OpenAI Agents API。部分路由已被识别,但返回 HTTP 501 Not Implemented,不单独建文档页:
  • Vaults:GET|POST /v1/vaults、GET /v1/vaults/{vault_id}、GET /v1/vaults/{vault_id}/credentials
  • Environments:GET|POST /v1/agents/environments、GET /v1/agents/environments/{environment_id}、GET|POST /v1/agents/environments/{environment_id}/files、GET /v1/agents/environments/templates
  • 会话产物:GET /v1/agents/sessions/{session_id}/artifacts