跳转到内容

快速开始

选择操作系统和客户端,跟随步骤完成 API Key 创建、模型选择、工具配置与第一次真实请求。

  1. 登录 悠然 AI 控制台,完成首次密码修改。
  2. 选择按量计费或已生效的席位订阅。
  3. 访问密钥页面创建一把独立的 API Key。
  4. 确认所有工具都使用以下 Base URL:
Base URL
https://youran-ai.du-fu.com/api

先通过模型列表确认当前可用的模型 ID:

Shell
curl -sS https://youran-ai.du-fu.com/api/models \
  -H "Authorization: Bearer <YOURAN_API_KEY>"

返回结果中的 data[].id 才是应写入客户端配置的模型 ID。模型列表可能变化,文档不会硬编码固定名称。

  • Claude Code:通过 /api/v1/messages 使用 Anthropic Messages 协议,但实际模型由悠然 AI 提供,当前仅支持 GPT 系列模型。
  • Codex 终端版:通过 /api/responses 使用 OpenAI Responses API,并以自定义 youran Provider 连接。
  • Codex 桌面版:在 ChatGPT 桌面应用中运行,与终端版共享用户级配置,但需要单独处理桌面进程的 API Key 读取。
  • Cursor:通过自带 API Key 与 OpenAI Base URL 覆盖接入,具体兼容范围以客户端当前版本为准。
  • 其他客户端:支持自定义 OpenAI Base URL、Bearer API Key 和模型 ID 的客户端,可参考其他兼容客户端接入。