所有请求都发往 https://api.embodiflow.io/v1,并带上 Authorization: Bearer <token>,令牌可以是个人访问令牌或 API 密钥。OpenAPI 文档可以从 /openapi.json 下载,也可以在全部端点中浏览。
约定
记住下面几条规则,所有端点用起来都是一个样子:
- 列表一次返回一页,页大小由
pageSize控制(默认 25,最大 100)。响应里有nextPageToken时,把它作为pageToken传入即可取下一页。请逐页读取,不要试图一次读完整个集合。 - 错误格式为
{ code, message }。code是稳定的,请根据它而不是消息文本做判断。 - 部分写操作接受
Idempotency-Key请求头。用相同的键和相同的请求体重发,会返回第一次的结果,所以重试是安全的。 - 遇到
429时,等待Retry-After给出的时间后再重试。 - 路径使用名词,动作被建模为资源,例如
.../submission-requests。 - 操作摘要和字段说明直接取自 OpenAPI 文档,因此在本站所有语言下都是英文。