调用前准备¶
每个接口页都假设请求里已经备齐四样东西:服务地址、凭据、工作区(仅 AI Studio)和路径里的资源 ID。本页说明这四样东西从哪里来、放在请求的什么位置。
服务地址¶
API |
服务前缀 |
调用对象 |
|---|---|---|
Genesis |
|
模型对话、嵌入、重排序 |
AI Studio |
|
工作区内的资源和任务 |
服务前缀只是开头,后面还有接口自己的路径。每个接口页顶部印着完整地址和方法——例如 Chat Completions 的 POST https://token.moi.matrixorigin.cn/v1/chat/completions——直接复制,不要凭前缀自己拼。
凭据¶
两类凭据都在控制台的访问凭据页领取,但放进请求的位置不同:
Genesis:放在
Authorization: Bearer <凭据>里。个人访问令牌和服务账号 API Key 均可,创建步骤见管理 Genesis 访问凭据。AI Studio:放在
X-API-Key: <个人访问令牌>里。部分接口还要求X-Workspace-ID请求头,工作区 ID 的取法见下一节。
一个请求只带一种认证方式:用了 X-API-Key,就不要再带 Authorization 或 Cookie。令牌也不要出现在 URL、日志、代码仓库或截图里。
工作区和资源 ID¶
AI Studio 的接口围绕工作区组织。先调查看工作区列表,从返回的 data.workspaces 里记下目标工作区的 id,填进后续请求的 X-Workspace-ID 请求头。
接口地址里的 {invitation_id} 这类占位符只认 ID、不认名称。ID 都从对应接口的返回里取:工作区 ID 来自查看工作区列表,任务 ID 来自创建任务接口的响应,其余资源依此类推。
响应怎么读¶
成功响应:接口页的「成功响应」一节逐个列出返回字段。后续调用要用的资源 ID、任务 ID、文件地址、分页标识,都从这一节取。
异步任务:创建、运行类接口返回成功只代表受理,不代表完成。保存任务 ID,按接口页给出的查询接口确认结果。
错误响应:错误结构写在各接口页的「错误响应」一节,两套 API 不通用,不要跨接口套用错误码。
下载和流式:标注了文件下载或流式输出的接口,按接口页说明保存文件或逐段读取事件,不要当普通 JSON 解析。