按「先上手、再理解规则、然后查字段」组织。每一节都是独立页面,链接可以直接发给同事。
先弄清楚它是什么,再发出第一个请求。
名字怎么解析、钱怎么算、任务怎么走完。
按模态查字段:约定与错误码、文本、图像、视频、语音与音乐、控制台接口。
约定与错误码
两个命名空间、请求与响应头约定、三种错误信封、完整错误码表、分页与版本兼容。
文本与对话
chat/completions 字段、流式帧、工具调用,以及 Anthropic 与 Gemini 两套原生协议的端点。
图像
images/generations 字段与响应、n 的真实语义、b64_json、尺寸与档位,以及厂商原生出图路径。
视频(四种格式)
通用 / Sora / 可灵 / 即梦四种入站格式的字段与信封、厂商原生路径、七态到四态的映射。
语音与音乐
语音合成(字节响应)、转写与翻译(multipart)、音乐异步任务与它们的计费特点。
控制台与管理接口
用脚本调控制台接口:换令牌、任务与账单端点、管理权限、分页与时间口径。
跨接口的做法:官方 SDK、流式、重试与幂等、迁移。
按「你看到什么」找原因,而不是按模块。
数据怎么处理、服务按什么条款提供。