查询便携版结果

接口信息

方法：GET POST
路径：
鉴权：请求头传 token
请求体：application/json, ?taskId={taskId}

接口作用

查询便携版任务的当前执行状态与最终结果。适用于以下场景：

创建任务时使用了 stream=false
SSE 连接中断后恢复结果查询
业务侧需要主动轮询任务进度

请求示例

GET 请求示例


curl --request GET \
  --url https://open.docmee.cn/v2/api/portable/task-result?taskId=PORTABLE_TASK_ID \
  --header "token: YOUR_TEMP_TOKEN"

POST 请求示例


curl --request POST \
 --url https://open.docmee.cn/v2/api/portable/task-result \
  --header "Content-Type: application/json" \
  --header "token: YOUR_TEMP_TOKEN" \
  --data '{
  "taskId": "PORTABLE_TASK_ID"
}'

后文中所有请求示例都以 POST 请求为例，您可以根据实际情况选择 GET 或 POST 请求。

请求参数

参数	类型	必填	说明
`taskId`	`string`	是	创建便携版任务后返回的任务 ID。GET 请求时，直接在 URL 中传入。

返回字段

字段	说明
`taskId`	任务 ID
`status`	任务状态：`pending`、`processing`、`success`、`failed`
`progress`	当前进度，可选
`step`	当前执行阶段，可选
`pptId`	成功时返回
`fileUrl`	成功时返回，PPT 下载地址
`coverUrl`	成功时返回，封面图地址
`previewUrl`	成功时返回，预览地址
`errorCode`	失败时返回
`errorMessage`	失败时返回

多语言示例


const response = await fetch('https://open.docmee.cn/v2/api/portable/task-result', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    token: 'YOUR_TEMP_TOKEN'
  },
  body: JSON.stringify({
    taskId: 'PORTABLE_TASK_ID'
  })
})
 
console.log(await response.json())


import requests
 
response = requests.post(
    'https://open.docmee.cn/v2/api/portable/task-result',
    headers={
        'Content-Type': 'application/json',
        'token': 'YOUR_TEMP_TOKEN'
    },
    json={
        'taskId': 'PORTABLE_TASK_ID'
    }
)
 
print(response.json())


package main
 
import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)
 
func main() {
  body := []byte(`{"taskId":"PORTABLE_TASK_ID"}`)
  req, _ := http.NewRequest("POST", "https://open.docmee.cn/v2/api/portable/task-result", bytes.NewBuffer(body))
  req.Header.Set("Content-Type", "application/json")
  req.Header.Set("token", "YOUR_TEMP_TOKEN")
 
  resp, _ := http.DefaultClient.Do(req)
  defer resp.Body.Close()
 
  data, _ := io.ReadAll(resp.Body)
  fmt.Println(string(data))
}


import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
 
public class PortableTaskResultExample {
  public static void main(String[] args) throws Exception {
    String body = """
      {
        "taskId": "PORTABLE_TASK_ID"
      }
      """;
 
    HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://open.docmee.cn/v2/api/portable/task-result"))
      .header("Content-Type", "application/json")
      .header("token", "YOUR_TEMP_TOKEN")
      .POST(HttpRequest.BodyPublishers.ofString(body))
      .build();
 
    HttpResponse<String> response = HttpClient.newHttpClient()
      .send(request, HttpResponse.BodyHandlers.ofString());
 
    System.out.println(response.body());
  }
}

响应示例

处理中：


{
  "code": 0,
  "data": {
    "taskId": "PORTABLE_TASK_ID",
    "status": "processing",
    "progress": 65,
    "step": "generate_ppt"
  }
}

成功：


{
  "code": 0,
  "data": {
    "taskId": "PORTABLE_TASK_ID",
    "status": "success",
    "progress": 100,
    "step": "completed",
    "pptId": "PPT_ID",
    "fileUrl": "https://example.com/demo.pptx",
    "coverUrl": "https://example.com/cover.png",
    "previewUrl": "https://example.com/preview"
  }
}

失败：


{
  "code": 5001,
  "data": {
    "taskId": "PORTABLE_TASK_ID",
    "status": "failed",
    "errorCode": "TASK_FAILED",
    "errorMessage": "generate ppt failed"
  }
}

响应字段说明

字段名	类型	示例	说明
`code`	`number`	`0`	通用响应状态码，0 表示成功。
`data`	`object`	`{"taskId":"PORTABLE_TASK_ID","status":"processing","progress`	业务数据对象。
`data.taskId`	`string`	`PORTABLE_TASK_ID`	字段用途请结合接口场景传入。
`data.status`	`string`	`processing`	当前处理状态。
`data.progress`	`number`	`65`	当前处理进度。
`data.step`	`string`	`generate_ppt`	字段用途请结合接口场景传入。