返回主站
快速入门

API 调用快速教程

准备 API Key，发送首个请求，理解响应与错误，并核对用量记录。

在控制台准备 API Key 和模型名称，使用自己的 API 客户端发送首个请求，再查看用量记录。本页提供请求与响应示例，不会发起 API 调用。

1. 准备调用条件

先准备可用的 API Key，确认模型名称及 Key 的分组、模型限制，再取得平台提供的 API 地址。

  1. 进入 API Key 页面，创建或选择一个已启用的 Key。
  2. 在模型广场查看模型名称，并确认它在该 Key 的分组和模型限制范围内。
  3. 使用平台提供的 Base URL，在自己的 API 客户端中发送下方非流式请求。
  4. 请求结束后，在用量记录中按时间、状态、模型和 Key 后缀核对结果。

2. 从 API 客户端发出首次请求

将示例中的 BASE_URL 替换为平台提供的 API 地址（包含 /v1），将 API_KEY 和 MODEL_ID 分别替换为你的 Key 和模型名称，同时去掉占位符两侧的尖括号。

curl --request POST '<BASE_URL>/chat/completions' \
  --header 'Authorization: Bearer <API_KEY>' \
  --header 'Content-Type: application/json' \
  --data '{
    "model": "<MODEL_ID>",
    "messages": [
      { "role": "user", "content": "Reply with a short connection confirmation." }
    ],
    "stream": false
  }'

请在自己的客户端中替换示例值。不要把真实 Key 提交到代码仓库、发送到聊天或留在命令历史中。

3. 查看响应

成功调用必须同时满足 HTTP 200、响应可解析、object = chat.completion，并且 choices0.message.content 存在。

{
  "id": "<COMPLETION_ID>",
  "object": "chat.completion",
  "created": 0,
  "model": "<MODEL_ID>",
  "choices": [
    {
      "index": 0,
      "message": { "role": "assistant", "content": "<MODEL_OUTPUT>" },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 0,
    "completion_tokens": 0,
    "total_tokens": 0
  }
}

以下 JSON 仅说明响应结构，实际结果以本次请求返回的 HTTP 状态和内容为准。

失败响应使用统一 OpenAI-compatible error envelope：

{
  "error": {
    "message": "<USER_VISIBLE_MESSAGE>",
    "type": "<ERROR_TYPE>",
    "param": "<RELATED_PARAMETER_OR_NULL>",
    "code": "<ERROR_CODE>"
  }
}
HTTP 状态当前判断下一步
400JSON、模型或请求字段不成立核对请求体、模型名称与 error.param/code。
401Bearer 缺失、格式错误或 Key 不可用检查 Authorization 请求头与 Key 状态，不要向支持人员发送 Key 明文。
403当前 Key 对模型、分组或来源无权检查 API Key 的分组、模型限制和来源限制。
429额度、预算或限流拒绝读取 error.code 和存在时的 Retry-After，停止无间隔重试。
422服务端判定请求无法处理根据 error.message 和相关字段修正请求。
503服务当前不可用保留发生时间和错误码，稍后重试或联系支持。
无 HTTP 响应请求结果未知先到 Console 请求记录核对，禁止立即自动重放可能计费的请求。

4. 核对用量记录

  1. 打开用量记录，选择覆盖本次调用时间的查询范围。
  2. 按时间、状态、模型和 Key 后缀查找对应记录，无需再次输入 Key 明文。
  3. 对照本次响应，核对记录中的状态、模型、Key 后缀和发生时间。
  4. 记录可能稍有延迟。请保留响应并手动刷新，不要因为列表暂时为空而立即重复发送请求。
请求结果未知时，先查记录
网络中断不代表请求没有执行。请先核对用量记录；记录服务暂不可用时，保留响应和发生时间，待恢复后再确认，避免重复计费。

保护 API Key

  • 仅在自己的 API 客户端中使用 Key，本页不会读取或保存它。
  • 不要将 Key 放入网址、公开页面或代码仓库。
  • 分享截图、日志或排障信息前，移除 Key、Authorization、Cookie 等凭据信息。
  • 若怀疑 Key 已泄露，及时在控制台停用或删除，并更新客户端使用的 Key。

隐私政策

Code4AI 隐私政策。

© 2026 Code4AI · code4ai.top