❗限制条件
本页只说明接入前必须明确的约束,不展开完整接口契约。
鉴权方式
- 调用接口时在请求头中传入 获取Token
- 提交任务接口请求体类型为
application/json - 提交任务接口响应类型为
text/event-stream
地区与 Origin
国内调用建议显式携带:
Origin: https://www.docmee.cn
并在请求体中传:
{ "address": "cn" }
服务端会根据请求来源判断国内或海外账号体系,判断优先级为:
Origin > Referer > X-Forwarded-Host > Host > body.address
国内 API 调用建议
API 调试工具、后端脚本和服务端转发通常不会自动携带 OriginHosttoken
国内接口调用请同时保持 Origin: https://www.docmee.cn "address": "cn"
图片 URL 约束
中每个元素代表一页 PPT。items 必须是服务端可直接访问的图片 URL。items[].image_url- 图片 URL 响应内容应为图片,不要返回 HTML、JSON、鉴权页或跳转页。
- 不建议使用内网地址、依赖浏览器登录态的地址或即将过期的签名地址。
数组顺序就是最终 PPT 的页顺序。items
remove_mode 约束
remove_mode
| 值 | 说明 |
|---|---|
text | 仅处理文字,输出可编辑文字层 |
elements | 仅处理元素,跳过文字去除 |
all | 同时处理文字和元素,输出更完整的可编辑 PPT |
首次接入如果没有特殊需求,建议使用 all
SSE 断线约束
- SSE 断开后,后端任务仍会继续执行。
- 收到
事件后必须保存started 。debug_id - 如果客户端没有收到
或finished ,应通过状态查询接口补查结果。failed - 状态查询接口不会重新生成 PPT,也不会再次扣积分。
部分成功约束
- 只要至少 1 页成功,任务会返回
。finished - 生成的 PPT 只包含成功页。
- 失败页会在
中返回。failed_items - 只有成功转换的图片页会计费,失败图片不计费;计费规则见 能力计费。
Last updated on