API 文档
从注册到第一次 API 调用
从账户准备到第一次 API 调用的完整路径。
你会完成什么
按照这套文档操作后,你将能够:
- 登录控制台并确认账户、余额和分组状态。
- 创建一把可单独撤销的 API Key,并从实时列表选择模型。
- 使用 cURL 或常用开发客户端完成第一次 API 调用。
唯一 Base URL
https://suoxie.codes/v1
如果你第一次接触 API,直接从五分钟快速开始开始。教程会告诉你每一步点哪里、成功后应该看到什么,以及失败时先检查什么。
开始前准备
- 一个可以接收验证信息的账户。
- 当前官方渠道提供的有效兑换码或可用余额。
- 一台可以运行 cURL、浏览器或开发客户端的电脑。
- 大约 5 至 10 分钟。第一次配置客户端时可能需要重启客户端。
文档中的 <API_KEY>、<MODEL> 和 <TASK_ID> 都是占位符。实际执行命令前必须替换它们,尖括号本身不要保留。
按目标选择入口
| 你的目标 | 从这里开始 | 完成标志 |
|---|---|---|
| 第一次接入 | 五分钟快速开始 | 最小请求返回 HTTP 200 |
| 准备账户 | 注册与登录 | 能看到控制台和 API 密钥入口 |
| 创建密钥 | 创建 API Key | 已安全保存完整 Key |
| 配置编辑器 | Codex 或 Cursor | 客户端能返回一条短回复 |
| 服务端调用 | Responses API | 能识别响应中的 status 和 output |
| 图像长任务 | 异步图像任务 | 任务从 processing 进入最终状态 |
| 定位失败 | 常见错误 | 已找到状态码对应的下一项检查 |
三个核心概念
| 术语 | 它是什么 | 最容易出错的地方 |
|---|---|---|
| Base URL | 所有兼容接口共用的地址前缀 | 客户端又自动追加 /v1,形成重复路径 |
| API Key | 代表当前账户和权限的调用凭证 | 把 Key 写进前端代码、截图或 Git 仓库 |
| 分组 | 决定可用平台、模型、权限和计费范围 | 从旧截图复制了当前分组不可用的模型名 |
推荐阅读顺序
第一次使用时,按“账户与余额 → API Key 与分组 → 模型列表 → 最小请求 → 客户端配置”的顺序进行。不要一开始就加入流式输出、工具调用、图片或高并发;先让最小请求稳定返回,再逐项增加功能,这样更容易定位问题。
安全边界
API Key 只放在本地环境变量、受限配置文件或密钥管理器中。浏览器前端代码会把 Key 暴露给访问者,不适合直接调用生产 API。发现泄露时,先在控制台撤销旧 Key,再创建并替换新 Key;不要只删除聊天记录或提交记录。
