GuDog API调用文档
OPENAI-COMPATIBLE API

几分钟接入 GuDog API

使用统一地址调用可用的大模型。将官方示例中的 Base URL 和 API Key 替换为下方配置即可。

推荐 Base URLhttps://ai.yuanown.com/v1
提示:模型名称、支持的接口与实际价格请以控制台“模型广场”为准,不要凭示例猜测模型名。

鉴权方式

OpenAI 兼容接口使用 Bearer Token。请在控制台创建令牌,并通过请求头发送:

HTTP Header
Authorization: Bearer sk-your-api-key
Content-Type: application/json

下文中的 sk-your-api-key 均为占位符,请替换为你自己的令牌。不要把真实密钥提交到 Git 仓库或前端代码。

获取模型列表

先查询当前令牌可用的模型,再把返回结果中的 id 用于后续请求。

cURL
curl https://ai.yuanown.com/v1/models \
  -H "Authorization: Bearer sk-your-api-key"

Chat Completions

适用于支持 OpenAI Chat Completions 协议的模型与客户端。

POST /v1/chat/completions
curl https://ai.yuanown.com/v1/chat/completions \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-model-id",
    "messages": [
      {"role": "system", "content": "你是一个有帮助的助手。"},
      {"role": "user", "content": "用一句话介绍武汉。"}
    ],
    "stream": false
  }'
OpenAI Python SDK
from openai import OpenAI

client = OpenAI(
    api_key="sk-your-api-key",
    base_url="https://ai.yuanown.com/v1",
)

response = client.chat.completions.create(
    model="your-model-id",
    messages=[
        {"role": "user", "content": "用一句话介绍武汉。"}
    ],
)

print(response.choices[0].message.content)
OpenAI Node.js SDK
import OpenAI from "openai";

const client = new OpenAI({
  apiKey: "sk-your-api-key",
  baseURL: "https://ai.yuanown.com/v1",
});

const response = await client.chat.completions.create({
  model: "your-model-id",
  messages: [
    { role: "user", content: "用一句话介绍武汉。" },
  ],
});

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

流式响应

stream 设置为 true,服务端会以 SSE 逐段返回内容。

Python · streaming
stream = client.chat.completions.create(
    model="your-model-id",
    messages=[{"role": "user", "content": "写一首短诗。"}],
    stream=True,
)

for chunk in stream:
    text = chunk.choices[0].delta.content
    if text:
        print(text, end="", flush=True)

Responses API

部分模型支持 OpenAI Responses 协议。是否可用取决于具体模型与渠道;如果返回接口不支持,请改用 Chat Completions。

POST /v1/responses
curl https://ai.yuanown.com/v1/responses \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-model-id",
    "input": "解释什么是 API 网关。"
  }'

Anthropic Messages

Claude 模型在渠道支持时可使用 Anthropic 原生 Messages 接口。鉴权头与 OpenAI 协议不同:

POST /v1/messages
curl https://ai.yuanown.com/v1/messages \
  -H "x-api-key: sk-your-api-key" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-claude-model-id",
    "max_tokens": 1024,
    "messages": [
      {"role": "user", "content": "你好,请介绍一下自己。"}
    ]
  }'
注意:请从模型广场复制准确模型名。并非所有 Claude 渠道都开放原生接口;接口不兼容时请使用 OpenAI 兼容格式。

常用客户端配置

Cherry Studio / ChatBox

供应商选择“OpenAI”或“自定义 OpenAI”,API 地址填 https://ai.yuanown.com/v1,填入令牌后获取或手动添加模型。

Cursor / Cline / Roo Code

选择 OpenAI Compatible,自定义 Base URL 与 API Key;模型名必须与模型广场完全一致。

Claude Code

仅在所选渠道支持 Anthropic 原生协议时配置。Base URL 通常填写不带末尾 /v1https://ai.yuanown.com

Dify / FastGPT / Open WebUI

使用 OpenAI Compatible 提供商,Base URL 填推荐地址;若客户端自动追加 /v1,则填写不带 /v1 的站点地址。

URL 规则:多数 SDK 需要 https://ai.yuanown.com/v1;有些客户端会自行追加 /v1。若出现 /v1/v1/...,请移除配置中的一个 /v1

备用域名

三个入口指向同一服务。正常情况下优先使用主域名;主域名网络异常时再切换备用入口。

推荐https://ai.yuanown.com/v1
备用https://api.ai.yuanown.com/v1
原始https://gai.fj.kg/v1

错误排查

401 Unauthorized

令牌缺失、错误、已禁用或请求头格式不正确。确认使用 Authorization: Bearer sk-...;Anthropic 原生接口则使用 x-api-key

403 Forbidden

令牌分组或权限不允许访问当前模型,也可能触发了安全策略。更换有权限的模型或检查令牌设置。

404 Not Found

常见原因是 Base URL 或接口路径错误。检查是否重复添加 /v1,以及接口应为 /chat/completions/responses/messages

429 Too Many Requests

请求过快、并发超限、额度不足或上游限流。降低并发并采用指数退避,随后检查余额与调用日志。

模型不存在或不可用

不要手输猜测模型名。调用 GET /v1/models 或从模型广场复制模型 ID,并确认令牌所属分组可用。

请求超时或 5xx

先短暂重试,再查看控制台调用日志。持续异常时可切换备用域名,并向 QQ 售后群提供时间、模型、错误码和请求 ID;请勿发送完整 API Key。

安全建议

  • API Key 只保存在服务端环境变量或密钥管理服务中。
  • 为不同应用创建独立令牌,并设置合理额度与权限。
  • 日志中隐藏完整令牌,公开报错时仅保留首尾少量字符。
  • 怀疑泄露时立即禁用旧令牌并创建新令牌。
ABOUT GUDOG API

关于 GuDog API

GuDog API 是武汉元自互联网科技有限公司推出的 AI API 服务聚合平台,面向国内开发者、技术团队与企业用户,提供统一、便捷的大模型接口接入能力。

平台定位

GuDog API 将多种 AI 模型能力汇聚到统一入口,为应用开发、自动化工作流和团队协作提供一致的调用方式。兼容 OpenAI 标准格式的 SDK 与工具通常只需替换 Base URL、API Key 和模型名称即可接入。

平台提供渠道、令牌、模型权限、用量与调用日志等管理能力,帮助用户减少重复适配不同接口协议的工作,将更多精力投入产品开发与业务创新。

01

统一接入

通过统一的 API 地址和鉴权方式接入模型。兼容 OpenAI 标准格式的工具与 SDK 通常只需替换 Base URL、API Key 和模型名称。

02

渠道调度

平台可根据实际渠道配置进行负载分配和故障转移,降低单一渠道异常对调用的影响。

03

用量管理

提供令牌、调用日志和用量统计等能力,方便个人与团队了解调用情况,并对模型权限和使用额度进行管理。

04

访问控制

通过独立令牌、模型权限及调用记录等机制提升接口使用的可控性。用户也应妥善保管密钥,并避免在客户端或公开代码中泄露。

适用场景

  • 个人开发者:快速验证模型能力,为脚本、机器人和个人项目接入 AI。
  • 创业与研发团队:减少多供应商接口适配成本,专注产品和业务逻辑。
  • 企业内部工具:为团队提供统一入口,并集中管理令牌、模型权限和用量。
  • AI 应用开发:支持聊天助手、内容生成、代码辅助及工作流自动化等场景。

服务与责任

平台重视服务安全与用户隐私,并持续完善访问控制、运行监测和风险管理措施。用户在调用服务时,也应遵守适用的法律法规、平台规则及相关模型服务条款,不得将接口用于违法违规用途。

商务合作、意见反馈与服务咨询 gudog@yuanown.com
发送邮件
已复制