快速开始 | Jerry API 文档

文档快速开始

1. 准备账户与密钥

注册并验证邮箱
登录后完成邮箱验证，确保账户通知和找回流程可用。
确认可用额度
充值或兑换额度后，再进行真实模型请求。
创建 API Key
在密钥管理中创建新密钥，例如命名为 MacBook-Codex。不要让多个设备长期共用同一枚密钥。
保存一次
密钥创建后请立即妥善保存，后续示例中的 YOUR_JERRY_API_KEY 均替换为这枚密钥。

2. 认清四种地址

不同工具对“地址”的定义不完全相同。看到 Base URL 时填写到 /v1；只有明确要求 Endpoint 时，才填写完整接口路径。

用途	地址	常见使用位置
Base URL	`https://www.jerryapi.com/v1`	Codex、OpenCode、Cursor、OpenClaw、Hermes
Chat Completions	`https://www.jerryapi.com/v1/chat/completions`	WorkBuddy 的 Endpoint 字段、curl 测试
Responses	`https://www.jerryapi.com/v1/responses`	Codex 与支持 Responses 的智能体
模型列表	`https://www.jerryapi.com/v1/models`	检查密钥可见的模型

不要重复添加路径

如果工具会自动拼接 /chat/completions，Base URL 就不要写成完整 Endpoint，否则可能出现 /v1/chat/completions/chat/completions。

3. 查看可用模型

在终端运行下面的命令。返回 JSON 模型列表，说明域名、TLS 和 API Key 均已通过验证。

Terminal

curl https://www.jerryapi.com/v1/models \
  -H "Authorization: Bearer YOUR_JERRY_API_KEY"

Jerry API 当前启用的 GPT 型号包括 gpt-5.4、gpt-5.4-mini 和 gpt-5.5。实际可见范围以你的密钥权限和控制台模型列表为准。

4. 发送第一条请求

Chat Completions · curl

curl https://www.jerryapi.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_JERRY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4",
    "messages": [
      {"role": "user", "content": "用一句话确认连接成功"}
    ],
    "stream": false
  }'

Python

Python · OpenAI SDK

from openai import OpenAI

client = OpenAI(
    api_key="YOUR_JERRY_API_KEY",
    base_url="https://www.jerryapi.com/v1",
)

response = client.chat.completions.create(
    model="gpt-5.4",
    messages=[{"role": "user", "content": "确认连接成功"}],
)

print(response.choices[0].message.content)

JavaScript

JavaScript · OpenAI SDK

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.JERRY_API_KEY,
  baseURL: "https://www.jerryapi.com/v1",
});

const response = await client.chat.completions.create({
  model: "gpt-5.4",
  messages: [{ role: "user", content: "确认连接成功" }],
});

console.log(response.choices[0].message.content);

5. 核对用量

请求成功后进入使用记录，按时间和密钥查找刚才的请求。你可以看到模型、Token 消耗、费用和响应状态，用于核对工具是否走了正确的密钥与模型。

查看使用记录选择 GPT 模型

常见错误

状态	通常原因	处理方式
`401`	密钥错误、漏写 Bearer	重新复制密钥，确认请求头为 `Authorization: Bearer ...`
`403`	密钥权限或 IP 限制	检查密钥的模型范围、分组和允许 IP
`404`	地址路径拼接错误	确认 Base URL 与完整 Endpoint 没有混用
`429`	额度不足或请求过快	检查余额、限额与并发，稍后重试
`5xx`	上游暂时异常	保留请求时间和错误信息，重试后仍失败再联系支持