快速开始

yuanjingaigc 提供统一的 OpenAI 兼容接口。只需 3 步，5 分钟即可完成接入。

注册获取 Key

注册账号（用户名 + 密码），在控制台创建 API Key

替换接口地址

将 base URL 替换为 yuanjingaigc 地址

选择模型调用

通过 model 参数指定模型，开始调用

获取 API Key

注册账号后，在控制台的「API Keys」页面创建新的 Key。建议为不同项目创建独立的 Key，便于管理用量。

安全提示：API Key 等同于你的账户密码，请勿泄露或提交到公开仓库。建议使用环境变量管理。

环境变量配置

# .env 文件
export YUANJINGAIGC_API_KEY="sk-xxxxxxxxxxxxxxxxxxxx"

第一次调用

将 OpenAI SDK 的 base_url 替换为 yuanjingaigc 地址，api_key 替换为你的 yuanjingaigc Key，即可开始调用。

# pip install openai
from openai import OpenAI

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

response = client.chat.completions.create(
    model="deepseek-v4-pro",
    messages=[
        {"role": "user", "content": "Hello!"}
    ]
)

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

认证方式

所有请求需要在 Header 中携带 Authorization: Bearer YOUR_API_KEY。

HTTP Header

Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

对话补全

接口地址：POST /v1/chat/completions

与 OpenAI Chat Completions API 100% 兼容。支持 system / user / assistant 角色，支持多轮对话。

请求示例

curl https://api.yuanjingaigc.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-your-key" \
  -d '{
    "model": "deepseek-v4-pro",
    "messages": [
      {"role": "system", "content": "你是一个翻译助手。"},
      {"role": "user", "content": "Translate: Hello world"}
    ]
  }'

响应示例

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "model": "deepseek-v4-pro",
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "你好，世界"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 20,
    "completion_tokens": 8,
    "total_tokens": 28
  }
}

流式输出

设置 stream: true 即可启用 SSE 流式输出，边生成边返回。

Python 流式调用

from openai import OpenAI

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

stream = client.chat.completions.create(
    model="deepseek-v4-pro",
    messages=[{"role": "user", "content": "写一首关于秋天的诗"}],
    stream=True,
)

for chunk in stream:
    print(chunk.choices[0].delta.content or "", end="")

视觉理解

支持视觉输入的模型可在 messages 中传入 image_url 进行图文对话。当前开放模型中 deepseek-flash 支持图片输入。

图片理解请求

curl https://api.yuanjingaigc.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-your-key" \
  -d '{
    "model": "deepseek-flash",
    "messages": [{
      "role": "user",
      "content": [
        {"type": "text", "text": "What is in this image?"},
        {"type": "image_url", "image_url": {"url": "https://example.com/image.jpg"}}
      ]
    }]
  }'

向量嵌入

接口地址：POST /v1/embeddings。用于文本向量化，支持 RAG、语义搜索等场景。⚠ 当前暂未开放向量模型（模型广场暂无 embedding 模型），以下仅为协议格式示例，开放后以模型广场为准。

Embedding 请求

curl https://api.yuanjingaigc.com/v1/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-your-key" \
  -d '{
    "model": "<embedding-model>",
    "input": "The quick brown fox"
  }'

请求参数

Chat Completions 支持以下参数，与 OpenAI 完全兼容：

参数	类型	默认	说明
model	string	—	必填，模型名称
messages	array	—	必填，对话消息列表
temperature	float	1.0	采样温度，0-2
max_tokens	int	auto	最大生成 Token 数
top_p	float	1.0	核采样概率
stream	bool	false	是否流式输出
tools	array	null	工具调用（function calling）
response_format	object	null	JSON 模式输出
seed	int	null	随机种子，可复现

Python SDK

直接使用官方 OpenAI Python SDK，只需替换 base_url 和 api_key。

安装 & 配置

# 安装
pip install openai

# 使用
from openai import OpenAI

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

response = client.chat.completions.create(
    model="deepseek-v4-pro",
    messages=[{"role": "user", "content": "你好"}],
)

Node.js SDK

使用官方 openai npm 包，同样只需替换配置。

安装 & 配置

# 安装
npm install openai

// 使用
import OpenAI from "openai";

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

const response = await client.chat.completions.create({
  model: "deepseek-v4-pro",
  messages: [{ role: "user", content: "Hello" }],
});

cURL

无需安装任何 SDK，直接用 cURL 发起请求。

cURL 请求

curl https://api.yuanjingaigc.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-your-key" \
  -d '{
    "model": "deepseek-v4-pro",
    "messages": [{"role": "user", "content": "Hi"}]
  }'

LangChain 集成

通过 ChatOpenAI 组件接入，设置 base_url 为 yuanjingaigc 地址即可。

LangChain + yuanjingaigc

from langchain_openai import ChatOpenAI

llm = ChatOpenAI(
    model="deepseek-v4-pro",
    api_key="sk-your-yuanjingaigc-key",
    base_url="https://api.yuanjingaigc.com/v1",
)

response = llm.invoke("What is 2+2?")
print(response.content)

错误码

API 返回标准 HTTP 状态码，错误响应包含 JSON 格式的错误信息：

错误响应格式

{
  "error": {
    "message": "Invalid API key",
    "type": "authentication_error",
    "code": "invalid_api_key"
  }
}

状态码	类型	说明
200	success	请求成功
400	bad_request	请求参数错误
401	authentication_error	API Key 无效或过期
403	permission_error	无权限调用该模型
429	rate_limit_error	请求频率超限，请稍后重试
500	server_error	服务内部错误，请稍后重试
503	service_unavailable	模型暂时不可用，请切换模型

计费说明

按量计费

用多少扣多少，无月费、无最低消费。充值后余额永久有效。

计费单位

以 Token 为单位计费。输入、缓存命中、输出分别计价，具体单价见模型广场（价格跟随后台货币设置，当前为人民币）。

充值方式

控制台支持兑换码充值；在线支付等能力以控制台实际提供为准。额度与人民币折算关系见充值页说明。

账单查询

在控制台可查看实时用量、Token 消耗明细、按模型和时间维度的统计分析。

速率限制

•平台按账号、分组与模型在网关侧配置调用限额（RPM / 并发）。
•具体限额以控制台展示和实际调用返回为准；如需更高并发或专属配额，请联系商务。

常见问题

切换模型需要修改代码吗？

不需要。只需修改 model 参数即可切换模型，其他代码完全不变。例如从 "deepseek-v4-pro" 切换到 "deepseek-flash" 只需改一个字符串。

支持流式输出吗？

支持。设置 stream: true 即可启用 SSE 流式输出，边生成边返回。支持流式的模型均可使用。

支持 Function Calling 吗？

支持。通过 tools 参数传入函数定义，模型会返回 tool_calls，用法与 OpenAI 兼容。当前 DeepSeek 系列模型支持工具调用。

数据安全如何保障？

所有请求通过 TLS 加密传输，平台不存储对话内容，仅记录 Token 消耗用于计费。如需私有化部署或更高配额，请联系商务。