API

Base URL 与认证

所有 OpenAI-compatible 请求都通过同一个网关地址和 Bearer API key 认证。

概述

UOUODUO Gateway 对外提供 OpenAI-compatible 的 `/v1` API。大多数 SDK、CLI、客户端和自研服务只需要改两处：base URL 与 API key。

文档中的 base URL 统一使用占位值，部署域名确定后再全站替换。

https://api.example.com/v1

认证

Header必需说明
Authorization✓`Bearer $UOUODUO_API_KEY`
Content-Type视请求而定JSON 请求使用 `application/json`，文件上传使用 `multipart/form-data`

创建 API key

  1. 打开 UOUODUO 控制台 `/app/keys`
  2. 创建一个新的 API key
  3. 按环境拆分 key，例如 `dev`、`staging`、`production`
  4. 在服务端环境变量中保存：
export UOUODUO_API_KEY="sk-xxx..."

快速验证

curl https://api.example.com/v1/models \
  -H "Authorization: Bearer $UOUODUO_API_KEY"

成功时会返回当前 key 可访问的模型列表。随后可以打开 `/app/logs` 和 `/app/usage` 检查请求、延迟、token 与成本。

常见问题

问题处理方式
401 Unauthorized检查 API key 是否来自 `/app/keys`，并确认没有复制空格
403 Forbidden当前 key 可能被限制模型、分组或额度
404 Not Found检查 base URL 是否包含 `/v1`
429 Too Many Requests查看 `/docs/guides/rate-limits`
余额不足查看 `/docs/guides/billing`