歌者 Open API

创建渲染任务

POST

https://api.gezhe.com/v1/renders

创建一个渲染任务，支持将 pptx、keynote、pdf 文件渲染为图片或视频，此任务为异步，获取结果需要调用查询任务详情接口获取。

请求参数

Body 参数multipart/form-data

file

可选

直接上传文件，需小于 30M，（file/fileURL 必须二选一，不能同时为空，也不能同时有值)，支持 pptx、pdf 格式文件

fileURL

string

可选

文件访问 URL，需小于 100M，（file/fileURL 必须二选一，不能同时为空，也不能同时有值)，支持 pptx、pdf 格式文件

name

string

可选

任务名称，不填时使用文件名

示例值:

渲染任务名称

mode

string

可选

渲染模式，当前只支持“normal” 模式，后续会推出字体增强、极速等模式

默认值:

normal

示例值:

normal

resolution

integer

可选

渲染分辨率，仅渲染到图片时有效，值为图片长边数值，默认为 1920 像素，可自定义为其他数值，需小于 5000，短边自动依据比例自适应

示例值:

1920

output

enum<string>

必需

可选 jpg、png、mp4，渲染到视频时，仅支持 720p 分辨率

枚举值:

jpgpngmp4

默认值:

jpg

示例值:

jpg

slides

string

可选

默认为全部，可指定页数，如 1,2,3 英文逗号分割，output 为 mp4 格式时无效，元素需要唯一，不能重复，结果将按数组页数顺序返回

示例值:

1,2,3

notifyURL

string

可选

合法的 url 地址，返回状态 200 即为收到通知

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.gezhe.com/v1/renders' \
--form 'file=@""' \
--form 'fileURL=""' \
--form 'name="渲染任务名称"' \
--form 'mode="normal"' \
--form 'resolution="1920"' \
--form 'output="jpg"' \
--form 'slides="1,2,3"' \
--form 'notifyURL=""'

返回响应

🟢200成功

application/json

Body

string

任务 ID

必需

任务唯一标识

示例

{
  "id": "string"
}

费用说明

查询任务详情