开发者文档
完整的 API 接入指南,支持 OpenAI-compatible formats、REST API 和流式输出。首次购买自动生成 API Key,已有密钥可直接充值。
快速开始
只需四步即可完成接入,整个过程不超过 5 分钟。
选择接入端点
根据你的客户端类型选择合适的 API 端点。支持 OpenAI-compatible、Responses-compatible 和 Messages-compatible 接口。
Base URL: https://gpt-agent.cc/v1获取 API Key
首次购买套餐后系统会自动生成首个 API Key,你也可以在控制台创建更多密钥。
Authorization: Bearer sk-your-api-key集成客户端
Use a compatible SDK or call the REST API directly with a custom base_url.
client = OpenAI(base_url='https://gpt-agent.cc/v1')开始调用
发送请求获取 AI 响应,支持流式输出以获得更好的用户体验。
POST /v1/chat/completions身份认证
所有 API 请求都需要在 HTTP Header 中携带 API Key 进行身份认证。
认证格式
在每个请求的 Authorization header 中添加你的 API Key。
/v1/chat/completions带认证的请求示例
curl https://gpt-agent.cc/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sk-your-api-key" \
-d '{
"model": "gpt-4o-mini",
"messages": [{"role": "user", "content": "Hello!"}]
}'{
"id": "chatcmpl_123",
"object": "chat.completion",
"choices": [{
"message": {
"role": "assistant",
"content": "Hello! How can I help you today?"
}
}]
}https://gpt-agent.cc/v1大部分客户端使用此地址https://gpt-agent.cc客户端验证失败时使用/v1/chat/completionsChat Completions compatible/v1/responses支持 Responses 格式的客户端优先使用/v1/messagesMessages-compatible 客户端优先使用聊天补全 API
OpenAI-compatible Chat Completions endpoint for multiple model ecosystems.
from openai import OpenAI
# 初始化客户端
client = OpenAI(
api_key="sk-your-api-key",
base_url="https://gpt-agent.cc/v1"
)
# 发送聊天请求
response = client.chat.completions.create(
model="gpt-4o-mini",
messages=[
{"role": "system", "content": "你是一个简洁的助手。"},
{"role": "user", "content": "用一句话介绍你自己。"}
]
)
print(response.choices[0].message.content)请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
model | string | 是 | 模型 ID,如 deepseek-r1 |
messages | array | 是 | 聊天消息数组 |
temperature | number | 否 | 采样温度,0-2,默认 1 |
max_tokens | integer | 否 | 生成 token 上限 |
stream | boolean | 否 | 是否启用流式输出 |
top_p | number | 否 | 核采样,默认 1 |
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
id | string | 响应唯一标识 |
object | string | 对象类型,固定为 chat.completion |
created | integer | 创建时间戳 |
model | string | 使用的模型 ID |
choices | array | 生成的回复选项 |
usage | object | token 使用统计 |
流式输出
启用流式输出可以实时接收生成的 token,显著降低用户感知延迟。
- 降低感知延迟 - 用户无需等待完整响应,可以立即看到内容
- 更好的长文本体验 - 内容像人类打字一样逐步显示
- 成本相同 - 与同步输出成本完全一致,只是传输方式不同
from openai import OpenAI
client = OpenAI(
api_key="sk-your-api-key",
base_url="https://gpt-agent.cc/v1"
)
# 启用流式输出
stream = client.chat.completions.create(
model="gpt-4o-mini",
messages=[
{"role": "system", "content": "你是一个简洁的助手。"},
{"role": "user", "content": "用一句话介绍你自己。"}
],
stream=True
)
# 实时打印每个 token
for chunk in stream:
if chunk.choices[0].delta.content is not None:
print(chunk.choices[0].delta.content, end="")
print() # 换行平台 REST API
用于购买、充值、查单、额度查询等平台功能的公开接口。
/api/purchase/orders创建首购订单,为新用户购买套餐创建订单
{
"email": "[email protected]",
"planCode": "starter",
"sourcePage": "/buy"
}{
"ok": true,
"data": {
"orderNo": "BUY202404060930ABCD",
"amountCents": 29900,
"contactEmail": "[email protected]",
"payUrl": "/buy/pay?orderNo=..."
}
}- 重试时请发送 x-idempotency-key 保证幂等性
/api/purchase/orders/pay准备支付会话,为已有订单生成支付链接
{
"orderNo": "BUY202404060930ABCD",
"contactEmail": "[email protected]"
}{
"ok": true,
"data": {
"orderNo": "BUY202404060930ABCD",
"checkoutUrl": "https://pay.example.com/...",
"qrcodeUrl": "https://pay.example.com/qrcode/..."
}
}- 使用订单创建时返回的订单号和邮箱
/api/purchase/orders/query查询首购订单状态和交付结果
{
"orderNo": "BUY202404060930ABCD",
"contactEmail": "[email protected]"
}{
"ok": true,
"data": {
"orderNo": "BUY202404060930ABCD",
"status": "PAID",
"deliveryState": "DELIVERED",
"contactEmail": "[email protected]"
}
}- 订单号和邮箱不匹配时返回 404
/api/topup/preview预览充值,验证 API Key 并查询当前额度
{
"apiKey": "sk-live_example"
}{
"ok": true,
"data": {
"valid": true,
"keyPrefix": "sk-live",
"keySuffix": "abcd12",
"beforeAvailableQuota": 5400000000,
"beforeUsedQuota": 1600000000,
"beforeTotalQuota": 7000000000,
"expiresAt": null
}
}- 充值前建议先调用此接口验证 Key 有效性
/api/topup/orders创建充值订单,为已有 API Key 充值
{
"apiKey": "sk-live_example",
"packageCode": "topup_100",
"contactEmail": "[email protected]",
"couponCode": "SAVE10"
}{
"ok": true,
"data": {
"orderNo": "TOP202404060935WXYZ",
"amountCents": 9000,
"contactEmail": "[email protected]",
"payUrl": "/topup/pay?orderNo=..."
}
}- couponCode 为可选的优惠码
/api/topup/orders/pay准备充值支付
{
"orderNo": "TOP202404060935WXYZ",
"contactEmail": "[email protected]"
}{
"ok": true,
"data": {
"orderNo": "TOP202404060935WXYZ",
"checkoutUrl": "https://pay.example.com/topup",
"qrcodeUrl": "https://pay.example.com/qrcode/..."
}
}/api/topup/orders/query查询充值订单状态
{
"orderNo": "TOP202404060935WXYZ",
"contactEmail": "[email protected]"
}{
"ok": true,
"data": {
"orderNo": "TOP202404060935WXYZ",
"status": "PAID",
"credited": true
}
}- 订单号和邮箱不匹配时返回 404
/api/quota/summary查询 API Key 额度摘要
{
"apiKey": "sk-live_example"
}{
"ok": true,
"data": {
"tokenName": "生产密钥",
"totalTokens": 7000000000,
"usedTokens": 1600000000,
"remainingTokens": 5400000000,
"responseTimeMs": 283
}
}- 返回当前额度和使用统计
/api/topup/packages获取可用充值套餐列表
GET /api/topup/packages{
"ok": true,
"data": [
{
"id": "pkg_100",
"code": "topup_100",
"name": "100元套餐",
"priceCents": 10000,
"quotaAmount": 7000000000
}
]
}- 无需认证,公开接口
错误码
API 可能返回的错误码及其处理建议。
| HTTP 状态码 | 错误名称 | 说明 | 处理建议 |
|---|---|---|---|
400 | INVALID_REQUEST | 请求格式错误或参数无效 | 检查请求体格式和参数 |
401 | UNAUTHORIZED | API Key 无效或已过期 | 检查 API Key 是否正确 |
429 | RATE_LIMIT | 请求频率超限 | 使用指数退避策略重试 |
500 | INTERNAL_ERROR | 服务内部错误 | 稍后重试 |
503 | SERVICE_UNAVAILABLE | 服务暂时不可用 | 稍后重试 |
限流说明
为了保证服务稳定性,我们对 API 请求进行频率限制。
- 每个 API Key 有独立的请求频率限制
- 收到 429 响应时请使用指数退避策略重试
- 流式和非流式请求共享相同的限流配额
- 付费用户享有更高的请求频率上限
定价说明
当前可用的购买和充值套餐,价格和额度实时更新。
| 类型 | 套餐 | 价格 | 基础额度 | 赠送 | 到账总额 |
|---|---|---|---|---|---|
| 购买 | 10 元首购套餐 | ¥10.00 | 0.25B | 0B | 0.25B |
| 购买 | 20 元首购套餐 | ¥20.00 | 0.5B | 0B | 0.5B |
| 购买 | 40 元首购套餐 | ¥40.00 | 1B | 0B | 1B |
| 购买 | 80 元首购套餐 | ¥80.00 | 2B | 1B | 3B |
| 购买 | 200 元首购套餐 | ¥200.00 | 5B | 2B | 7B |
| 购买 | 400 元首购套餐 | ¥400.00 | 10B | 4B | 14B |
| 充值 | 10 元充值套餐 | ¥10.00 | 0.25B | 0B | 0.25B |
| 充值 | 20 元充值套餐 | ¥20.00 | 0.5B | 0B | 0.5B |
| 充值 | 40 元充值套餐 | ¥40.00 | 1B | 0B | 1B |
| 充值 | 80 元充值套餐 | ¥80.00 | 2B | 1B | 3B |
| 充值 | 200 元充值套餐 | ¥200.00 | 5B | 2B | 7B |
| 充值 | 400 元充值套餐 | ¥400.00 | 10B | 4B | 14B |
| 充值 | 800 元充值套餐 | ¥800.00 | 20B | 8B | 28B |
额度不限时、不清零,可长期使用。套餐价格和赠送额度可能根据活动进行调整。