生成报告

接口概述

开放 API 专用报告生成接口，根据任务信息生成报告并返回处理结果。

请求地址

POST /generateReport

请求头

参数	必填	说明
apiKey	是	API 访问凭证
Content-Type	是	application/json

请求参数

参数	类型	必填	说明
taskId	String	是	任务 ID
wordUrl	String	否	WORD 报告地址
pdfUrl	String	否	PDF 报告地址
recognitionObjectQty	Number	否	识别对象数量
reportFormatList	Array	否	报告格式列表，取值参见报告格式

请求示例

curl -X POST "https://openapi.bangtu-ai.com/openApi/generateReport" \
  -H "apiKey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "taskId": "1900789012345678901",
    "reportFormatList": ["PDF"]
  }'

返回结果

{
  "code": 200,
  "message": "success",
  "data": {
    "taskId": "1900789012345678901",
    "wordUrl": "openApi/report/1900789012345678901.docx",
    "pdfUrl": "openApi/report/1900789012345678901.pdf"
  },
  "timestamp": 1784533680000
}

返回字段

字段	类型	说明
code	Number	通用响应码，200 表示成功
message	String	响应信息
data	Object | null	报告生成结果，通常包含报告地址
timestamp	Number	服务端响应时间戳，单位为毫秒

响应码

code	说明
200	请求成功
500	请求失败，具体原因见 message

注意事项

• 返回的报告地址可直接用于文件下载。
• 生成结果为 URL 形式时，若需要直接下载文件，请使用下载报告。