Guides

快速开始

从注册、创建密钥到第一次调用和查看用量的完整路径。

概述

这篇指南带你完成第一次 UOUODUO Gateway 调用。

整个流程只需要四步:创建账户、创建 API key、发送请求、在控制台查看日志和用量。

如果你已经熟悉 OpenAI 兼容接口,可以直接复用现有客户端,只需要替换 base URL 和 API key。

前置条件

  • 一个可登录的 UOUODUO 账户
  • 本机已安装 `curl`,或准备使用任意 OpenAI 兼容 SDK
  • 已确认当前账户有可用余额或测试配额
  • 已知道要调用的模型 ID,例如 `gpt-4o-mini` 或 `claude-3-5-sonnet`

1. 登录控制台

打开 UOUODUO 控制台并登录。

进入控制台后,先看左侧导航里的 Projects、API Keys、Logs 和 Usage。

第一次接入时不必创建复杂的项目结构,默认个人项目已经足够完成测试。

截图待补

2. 创建 API key

进入 `/app/keys`。

点击创建密钥,给它一个容易识别的名称,例如 `local-dev`。

如果你的团队启用了项目和预算管理,建议把密钥绑定到对应项目。

创建后立即保存密钥值。密钥只会完整显示一次。

3. 设置环境变量

推荐把密钥放进环境变量,而不是写入代码。

export UOUODUO_API_KEY="sk-xxx..."

Windows PowerShell 可以这样设置:

$env:UOUODUO_API_KEY="sk-xxx..."

不要把真实密钥提交到 Git。

如果需要在项目里使用 `.env`,请确认 `.env` 已加入 `.gitignore`。

4. 发起第一次请求

UOUODUO Gateway 使用 OpenAI 兼容的请求路径。

curl https://api.example.com/v1/chat/completions \
  -H "Authorization: Bearer $UOUODUO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o-mini",
    "messages": [
      { "role": "user", "content": "用一句话解释什么是 API 网关。" }
    ]
  }'

成功时你会收到包含 `choices` 的 JSON 响应。

如果返回 401,先检查密钥是否完整、是否带了 `Bearer` 前缀。

如果返回 402 或余额不足提示,进入 Billing 或 Credits 页面检查账户余额。

5. 查看日志

请求成功后打开 `/app/logs`。

日志页可以确认模型、路由、状态、延迟、费用和 token 数。

如果请求失败,日志里的错误信息通常比客户端看到的摘要更完整。

建议排障时把 request ID 一起复制给支持团队。

6. 查看用量

打开 `/app/usage`。

用量页按时间和模型展示消耗趋势,适合验证接入是否产生了预期费用。

如果你使用项目预算,也可以回到对应项目页查看预算状态。

7. 切到 SDK

确认 cURL 成功后,可以继续阅读 SDK 指南。

  • Python 用户阅读 `/docs/sdk/openai-python`
  • Node.js 用户阅读 `/docs/sdk/openai-node`
  • Anthropic Messages 用户阅读 `/docs/api/messages`
  • 只想确认 endpoint 字段时阅读 `/docs/api/chat-completions`

常见问题

base URL 应该填什么

统一填 `https://api.example.com/v1`。

部署前请不要在文档或代码示例中写真实生产域名。

模型名称从哪里看

进入 `/models` 查看公开模型目录,或在 `/app/playground` 的模型选择器里查看当前账户可用模型。

也可以请求 `/v1/models` 获取模型列表。

为什么同一个模型费用不同

费用可能受供应商、计费组、输入输出 token、缓存命中和路由策略影响。

以控制台日志里的最终费用为准。

下一步做什么

把密钥接入开发环境后,建议继续配置 Logs saved view、项目预算和密钥命名规范。

生产环境建议按项目或服务拆分密钥,避免多个应用共用同一个 key。