QingshanAPI QingshanAPI 文档
登录 获取密钥

OpenAI 兼容 · 多模型接入 · 接入文档

用一套接口
接入多种 AI 能力

QingshanAPI 提供兼容 OpenAI 风格的大模型接口。现有项目通常只需要替换接口基址和密钥，就能接入聊天、文本生成、向量、重排序、图像和音频等能力。

开始接入 查看接口

Quick Start

三步完成接入

QingshanAPI 保持 OpenAI SDK 的调用习惯。后端服务中配置密钥，将 base URL 指向QingshanAPI 即可开始请求。

推荐从 Responses API 开始
1

创建密钥

登录控制台，在 API Key 页面创建密钥。密钥只展示一次，请妥善保存在服务端环境变量。

2

替换基址

HTTP 请求使用 https://qingshanapi.com 加接口路径；OpenAI SDK 的 baseURL 通常设置为 https://qingshanapi.com/v1。

3

选择模型

在请求体中填写模型 ID。可先调用 /v1/models 获取当前可用模型列表。

Code Examples

常用调用示例

下面示例区分 HTTP 完整接口地址和 SDK baseURL。生产环境请从环境变量读取密钥，不要把密钥写入前端代码。

responses.js 
import OpenAI from "openai";

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

const response = await client.responses.create({
  model: "gpt-4.1",
  input: "用三句话介绍QingshanAPI"
});

console.log(response.output_text);
responses.py 
from openai import OpenAI
import os

client = OpenAI(
    api_key=os.environ["QINGSHAN_API_KEY"],
    base_url="https://qingshanapi.com/v1"
)

response = client.responses.create(
    model="gpt-4.1",
    input="用三句话介绍QingshanAPI"
)

print(response.output_text)
responses.sh 
curl https://qingshanapi.com/v1/responses \
  -H "Authorization: Bearer $QINGSHAN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4.1",
    "input": "用三句话介绍QingshanAPI"
  }'

Tool Setup

常用工具配置

推荐优先使用控制台里的工具配置入口自动生成配置；需要手动填写时，再按下方 Base URL 和环境变量配置。

推荐从控制台生成

控制台填入 CC Switch

推荐
令牌管理 / CC Switch

在控制台可直接把当前令牌写入 CC Switch，适合不想手动复制 Key 和 Base URL 的客户。

入口进入 令牌管理，点击 添加令牌；已有令牌可点右侧下拉菜单，选择 CC Switch。
应用在弹窗中选择 Claude、Codex 或 Gemini，按实际使用的工具选择。
模型填写名称后，选择主模型、Haiku 模型、Sonnet 模型和 Opus 模型；不知道怎么选时可先选择常用默认模型。
完成点击 打开 CC Switch，在 CC Switch 中确认配置并切换使用。
在QingshanAPI控制台中从令牌管理打开 CC Switch 配置弹窗的截图

CCSwitch / Claude Code

GUI
Provider Name: QingshanAPI

在 CCSwitch 中新增 Provider，填写 API Key 和 Base URL 后切换到该 Provider。

API Keysk-你的APIKey
Base URLhttps://qingshanapi.com
适用场景Claude Code、Claude 协议客户端、需要填写 Anthropic Base URL 的工具。

Claude Code 环境变量

ENV
ANTHROPIC_BASE_URL + ANTHROPIC_AUTH_TOKEN

不使用图形工具时，可在终端里临时设置环境变量后启动 Claude Code。

terminal 
export ANTHROPIC_BASE_URL="https://qingshanapi.com"
export ANTHROPIC_AUTH_TOKEN="sk-你的APIKey"
claude

Codex / OpenCode

CLI
OpenAI Compatible

使用 OpenAI 兼容协议的编码工具，一般填写 OpenAI API Key 和 OpenAI Base URL。

API Keysk-你的APIKey
Base URLhttps://qingshanapi.com/v1
模型名称填写控制台中可用的模型 ID。

Cursor / OpenAI SDK

SDK
OPENAI_API_KEY + OPENAI_BASE_URL

如果工具支持自定义 OpenAI Base URL，按下面方式填写即可。

.env 
OPENAI_API_KEY=sk-你的APIKey
OPENAI_BASE_URL=https://qingshanapi.com/v1

什么时候带 /v1

OpenAI SDK、Codex、OpenCode、Cursor 等 OpenAI 兼容配置通常填写 https://qingshanapi.com/v1。

什么时候不带 /v1

CCSwitch 配 Claude Code 或 Anthropic 协议工具时，Base URL 通常填写 https://qingshanapi.com。

Authentication

认证、请求头与错误

所有需要鉴权的接口都使用 Bearer Token。请求时请带上 JSON 内容类型，文件上传接口按 multipart/form-data 处理。

Authorization: Bearer sk-xxxx
Authorization必填。格式为 Bearer sk-xxxxxx，建议仅在服务端保存和调用。
Content-TypeJSON 接口使用 application/json；音频转录、图像编辑等上传类接口使用表单上传。
400请求参数不符合接口要求，例如缺少模型、消息数组格式错误或参数超出范围。
401密钥缺失、格式错误、已禁用或余额权限不足导致认证失败。
429触发频率限制、并发限制或上游限流。建议加入重试退避和任务队列。

API Reference

接口目录

这里列出客户接入时最常用的模型能力接口。具体可用模型、价格和权限以控制台展示为准。

Base URL + /v1 路径

列出模型

GET
/v1/models

获取当前密钥可访问的模型列表，便于接入前做模型选择和可用性检查。

Responses

POST
/v1/responses

推荐的新一代文本与多模态响应接口，支持多轮上下文、工具调用和推理参数。

聊天补全

POST
/v1/chat/completions

兼容传统 Chat Completions，适合已有聊天应用快速迁移。

文本补全

POST
/v1/completions

传统 prompt 补全接口，适合老项目或特定模型兼容场景。

文本向量

POST
/v1/embeddings

将文本转成向量，可用于检索增强、相似度匹配、聚类和推荐。

文档重排序

POST
/v1/rerank

根据查询文本重新排列候选文档，提升知识库检索结果质量。

内容审查

POST
/v1/moderations

对输入内容进行安全检查，可作为业务审核流程的一环。

图像生成

POST
/v1/images/generations

根据提示词生成图像，具体尺寸、质量和格式取决于所选模型。

Text & Reasoning

文本对话接口

新项目优先使用 /v1/responses。已有 OpenAI Chat Completions 项目可以继续使用 /v1/chat/completions，迁移成本更低。

model必填。模型 ID，例如 gpt-4.1、claude-sonnet-4、deepseek-r1 等，以控制台可用模型为准。
input / messagesresponses 使用 input；chat/completions 使用 messages 数组。
stream设置为 true 可启用流式输出，适合聊天框逐字显示和长内容生成。
temperature / top_p控制生成随机性。严谨任务建议降低 temperature，创意任务可以适当提高。
tools / tool_choice用于函数调用、工具调用或模型可用工具选择。不同模型支持情况会有差异。
reasoning_effort支持推理模型时可设置 low、medium、high，用于控制推理强度和成本。

Retrieval

向量与重排序

知识库应用通常先用 Embeddings 召回候选片段，再用 Rerank 对候选结果重新排序，最后把高相关内容交给对话模型生成答案。

Embeddings 参数

POST
model, input, encoding_format, dimensions

input 可以是字符串或字符串数组；dimensions 用于选择输出向量维度，需模型支持。

Rerank 参数

POST
model, query, documents, top_n, return_documents

documents 是候选文档列表；top_n 控制返回数量；return_documents 控制是否返回原文档。

Media APIs

图像与音频

多媒体接口覆盖文生图、图像编辑、文本转语音、音频转录和音频翻译。上传类接口请使用表单请求。

生成图像

POST
/v1/images/generations

核心参数包括 model、prompt、n、size、quality 和 style。

编辑图像

POST
/v1/images/edits

上传原图和编辑提示词，适合局部修改、换背景、生成变体等场景。

文本转语音

POST
/v1/audio/speech

把文本生成音频，常用参数包括 model、input、voice、format。

音频转录

POST
/v1/audio/transcriptions

上传音频文件并转写为文本，可用于会议纪要、字幕和语音输入。

Billing & Usage

费用与用量

客户可在控制台查看余额、调用记录和模型消耗。建议在正式上线前为不同项目创建独立 API Key，方便统计和控制预算。

以控制台为准

查看余额

WEB
控制台 / 账户余额

用于确认当前账户可用额度，避免线上服务因余额不足中断。

查看调用记录

WEB
控制台 / 调用日志

按时间、模型和接口查看请求记录，便于排查问题和核对消耗。

模型价格

WEB
控制台 / 模型列表

不同模型的价格、能力和上下文长度可能不同，请按业务场景选择合适模型。

预算控制

WEB
按项目拆分 API Key

为测试、生产和不同业务分别创建密钥，便于限制额度和快速停用异常调用。

Best Practices

使用建议

面向真实用户开放前，建议结合业务场景完善权限、限流、日志和异常处理，让服务更稳定也更容易排查问题。

密钥不要下发到前端

浏览器、App 包和公开仓库都不适合保存 API Key。建议通过你自己的后端转发请求。

为不同业务拆分密钥

按项目、环境、用户组创建不同 API Key，便于统计用量、限制额度和快速停用异常调用。

给上游波动留重试策略

对 429、5xx、网络超时加入指数退避；对可重试任务使用队列，避免瞬时失败影响用户体验。

建立内容与日志审计

对公开应用加入内容审查、滥用举报、请求日志和人工处置流程，并遵守上游服务条款。

已复制