接入概览

本指南帮助第三方开发者快速接入 AI 业务中台 OpenAPI。

前置条件

• 已获取 API Key（sk_*）
• 开发环境支持 HTTPS 请求
• 已阅读并同意平台接入协议

获取 API Key

每个 API Key 都绑定到创建它的工作空间，只能访问该工作空间下的资源。网关会根据 API Key 自动识别并注入工作空间上下文，调用方无需获取或传入工作空间 ID。

在 平台所在工作空间的 基础服务 → 开发管理 → 密钥管理 创建或获取 API Key：

https://runtime-platform.invalid/base/developer-manage/key-manage

请先确认页面顶部选择的是目标工作空间，再创建 API Key。该页面支持创建、查看和禁用 API Key。

网关地址

OpenAPI 基础地址：

https://runtime-api.invalid/v1/openapi

第一步：设置鉴权信息

OpenAPI 统一使用以下请求头：

Authorization: Bearer sk_***

建议先在本地环境变量中设置，避免硬编码：

export AIADP_BASE_URL="https://runtime-api.invalid/v1/openapi"
export AIADP_API_KEY="sk_your_api_key"

第二步：发起一次最小调用

以聊天接口为例：

curl -X POST "${AIADP_BASE_URL}/chat/send-messages" \
  -H "Authorization: Bearer ${AIADP_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "messages": [
      { "role": "user", "content": "你好" }
    ]
  }'

第三步：校验返回结果

成功时会返回业务 JSON（结构以具体接口文档为准），例如：

{
  "code": 0,
  "data": {},
  "request_id": "req_xxx"
}

如果返回鉴权错误（如 invalid api key、api key expired、认证格式错误），请优先检查 API Key 与 Authorization 请求头。

下一步

• 认证与鉴权 — 查看完整鉴权规则与头字段要求
• 错误处理 — 查看网关与鉴权服务的常见错误及排查方式