歌者 Open API
开发文档歌者首页
开发文档歌者首页
  1. 演示文稿渲染
  • 接入指引
  • 账号授权
  • 错误码说明
  • 演示文稿渲染
    • 费用说明
    • 创建渲染任务
      POST
    • 查询任务详情
      GET
    • 删除一个任务
      DELETE
  • 演示文稿翻译
    • 翻译流程说明
    • 费用说明
    • 创建翻译任务
      POST
    • 查询翻译任务
      GET
    • 删除翻译任务
      DELETE
    • 获取翻译对比
      GET
    • 提交修改后翻译的内容
      PUT
    • 获取下载地址
      GET
  • 演示文稿内容提取
    • 费用说明
    • 创建内容提取任务
      POST
    • 查询任务详情
      GET
    • 删除一个任务
      DELETE
  • 智能生成 PPT
    • 费用说明
    • 格式说明
    • 创建无损排版任务
      POST
    • 查询无损排版任务
      GET
    • 模板列表
      GET
  • 格式转换
    • 费用说明
    • 新建转换任务
      POST
    • 查询转换任务
      GET
  • PPT 导出为可播放的 HTML
    • 费用说明
    • 创建导出任务
    • 查询导出任务
  • 演示文稿压缩
    • 费用说明
    • 新建压缩任务
    • 查看压缩任务
  • 演示文稿防盗指纹
    • 费用说明
    • 添加防盗指纹
    • 校验防盗指纹
  • 演示文稿切分和合并
    • 演示文稿切分
    • 演示文稿合并
  • 彩漩阅读数据
    • 文档阅读者列表
    • 阅读列表
  1. 演示文稿渲染

查询任务详情

GET
https://api.gezhe.com/v1/renders/{id}
查看一个渲染任务,获取任务状态和结果文件

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Path 参数
id
string 
必需
示例值:
27C240801uztlDT
Query 参数
type
enum<string> 
返回的链接类型
可选
枚举值:
accessimagedownload
默认值:
access
name
string 
可选
期望下载的文件名 type=download 生效
Body 参数multipart/form-data
object {0}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.gezhe.com/v1/renders/27C240801uztlDT?type&name'

返回响应

🟢200成功
application/json
Body
id
string 
任务 ID
必需
任务唯一标识
name
string 
任务名称
必需
status
enum<string> 
任务状态
必需
枚举值:
pendingdoingdoneerror
target
array [array] 
转换后的文件
可选
string 
可选
3 个元素,分别为下载地址、文件大小、文件md5 值
finishedAt
string 
任务完成时间
可选
notifyURL
string 
接受任务状态变更的回调地址
可选
合法的 url 地址,返回状态 200 即为收到通知
errorCode
string 
错误码
可选
详情见:https://gezhe.apifox.cn/doc-5209548
errorMsg
string 
错误信息
可选
示例
{
  "userId": "UvyBQwS",
  "id": "UvyBQwSC240926tdAJaa",
  "name": "产品发布会",
  "status": "done",
  "errorMsg": null,
  "target": [
    [
      "https://gezhe-platform.oss-cn-beijing.aliyuncs.com/2024-09/b9/b9815857-69e6-49d2-8bde-97deaecac8f7.jpg",
      55102,
      "db5c68cdb8601fe27b9e965eaaca5723"
    ],
    [
      "https://gezhe-platform.oss-cn-beijing.aliyuncs.com/2024-09/ef/efb2e37b-5e53-4f8b-b205-f57672e0f46f.jpg",
      65832,
      "c19ef8380aadbb4f326c866442ab471f"
    ],
    [
      "https://gezhe-platform.oss-cn-beijing.aliyuncs.com/2024-09/34/34f5120c-b48e-4746-83bf-205e1c70c381.jpg",
      148257,
      "0e5ca68eabe083ee6466fd1d9fd8a928"
    ]
  ],
  "mode": "normal",
  "resolution": 1280,
  "output": "jpg",
  "slides": null,
  "creatorId": "WWUyXhnv",
  "finishedAt": "2024-09-26T02:08:51.000Z",
  "notifyURL": null,
  "notifyCount": 0,
  "createdAt": "2024-09-26T02:08:27.000Z",
  "updatedAt": "2024-09-26T02:08:51.000Z"
}
上一页
创建渲染任务
下一页
删除一个任务
Built with