开始使用

快速开始

鉴权、模型 ID 与首个请求

接入地址

API 地址为 https://www.yunqiai.chat，请按客户端要求填写下表中的地址。

使用方式	地址
OpenAI SDK 的 base_url / baseURL	`https://www.yunqiai.chat/v1`
Anthropic SDK / Claude Code 的 base URL	`https://www.yunqiai.chat`
Gemini REST	`https://www.yunqiai.chat/v1beta/models/{model}:generateContent`
Realtime WebSocket	`wss://www.yunqiai.chat/v1/realtime?model={model}`

OpenAI SDK 会在 base URL 后追加接口路径，填写时只保留一个 /v1。Claude Code 使用根地址，不填写 /chat/completions。

配置密钥

登录控制台，创建有目标模型权限的 API Key，并设置环境变量。接口使用 API Key 鉴权，不能使用账户密码。请在服务端保存密钥，避免将其写入前端、公开仓库、示例文件或错误日志。

powershell

$env:YUNQIAI_API_KEY = "你的 API Key"
$env:YUNQIAI_MODEL = "你选择的完整模型 ID"

bash

export YUNQIAI_API_KEY='你的 API Key'
export YUNQIAI_MODEL='你选择的完整模型 ID'

将 YUNQIAI_MODEL 设为模型目录中的完整 ID。大小写、标点和命名空间均需保留，例如 DeepSeek-V4.1-Flash。

读取密钥可见模型

bash

curl --fail-with-body 'https://www.yunqiai.chat/v1/models' \
  --header "Authorization: Bearer $YUNQIAI_API_KEY"

返回的 data[].id 是当前 Key 可见的模型 ID。调用权限取决于 Key 所属分组；模型是否能完成请求，还需通过对应接口确认。

发送请求

以下示例适用于使用 Responses 协议的模型。Claude、Gemini、Images、MJ 和 Realtime 的请求格式见各自接口页。

bash

curl --fail-with-body 'https://www.yunqiai.chat/v1/responses' \
  --header "Authorization: Bearer $YUNQIAI_API_KEY" \
  --header 'Content-Type: application/json' \
  --data "{\"model\":\"$YUNQIAI_MODEL\",\"input\":\"仅回复 READY\",\"max_output_tokens\":2048}"

文本位于 output[] 中 type=message 的内容项，读取其中 content[].type=output_text 的文字。首项可能是推理内容，因此需要遍历数组。响应完成后检查正文；incomplete、空文本和拒绝响应按异常结果处理。

Agent 文档入口

完整文档，无需登录读取。
Markdown 文件，与网页同源生成。
机器可读模型目录，包含精确模型 ID、协议及路径。
HTTP OpenAPI，WebSocket 事件另见 Realtime。

交给 Agent 接入时，同时提供要使用的模型 ID，并在运行环境配置 Key。调用失败后应保留所选模型和分组、报告原因。生图请求超时后，先确认任务状态再决定是否重发，避免重复生成。