1. 查询服务状态接口

请求方式: GET

请求地址: BASE_URL + /deepseek-ocr/health

请求参数:
无

请求和响应示例

curl -X GET "https://uni-api.cstcloud.cn/v1/deepseek-ocr/health" -H "Authorization: Bearer {Token}"

返回结果

{
    "status": "healthy",
    "processor_loaded": true
}

2. 提交 OCR 任务接口(仅面向PDF文件)

请求方式: POST

请求地址: BASE_URL + /deepseek-ocr/convert

请求参数:

• file: 必选, 上传的文件, FILE类型
• prompt: 可选, 进行OCR时的个性化提示词, 如不输入此参数, 默认值为 "<image>\n<|grounding|>Convert the document to markdown."
• skip_repeat: 可选, 是否跳过重复文件, 默认值为 true
• crop_mode: 可选, 是否开启裁剪来提高效率, 默认值为 true

请求和响应示例

curl -X POST "https://uni-api.cstcloud.cn/v1/deepseek-ocr/convert" \
    -H "Authorization: Bearer {Token}" \
    -F "file=@document.pdf" \
    -F "prompt=<image>\n<|grounding|>Convert the document to markdown." \
    -F "skip_repeat=true" \
    -F "crop_mode=true"

返回结果

{
    "task_id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "processing",
    "message": "PDF conversion started"
}

3. 查看 OCR 任务执行状态接口

请求方式: GET

请求地址: BASE_URL + /deepseek-ocr/status/:task_id

请求参数:

• task_id: 提交任务(接口2)时返回中的 task_id

请求和响应示例

curl -X GET "https://uni-api.cstcloud.cn/v1/deepseek-ocr/status/550e8400-e29b-41d4-a716-446655440000" -H "Authorization: Bearer {Token}"

返回结果

{
  "task_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "message": "PDF converted successfully",
  "output_file": "/path/to/output.mmd",
  "total_pages": 10,
  "processing_time": 45.2
}

4. 删除 OCR 任务接口

请求方式: DELETE

请求地址: BASE_URL + /deepseek-ocr/task/:task_id

请求参数:

• task_id: 提交任务(接口2)时返回中的 task_id

请求和响应示例

curl -X DELETE "https://uni-api.cstcloud.cn/v1/deepseek-ocr/task/550e8400-e29b-41d4-a716-446655440000" -H "Authorization: Bearer {Token}"

返回结果

{
    "message": "Task 550e8400-e29b-41d4-a716-446655440000 deleted successfully"
}

5. 下载 OCR 任务结果文件接口

请求方式: GET

请求地址: BASE_URL + /deepseek-ocr/download/:task_id/:type

请求参数:

• task_id: 提交任务(接口2)时返回中的 task_id
• type: 要下载的文件类型: markdown: 结果 Markdown 文件, markdown_det: 包含识别信息的结果 Markdown 文件, pdf_layout: 包含标注框的 PDF 文件, images_zip: 从 PDF 中提取的图片

请求和响应示例

curl -X GET "https://uni-api.cstcloud.cn/v1/deepseek-ocr/download/550e8400-e29b-41d4-a716-446655440000/markdown" -H "Authorization: Bearer {Token}" -o output.mmd

6. 文件存储时限说明

本服务对上传的 PDF 文件和转换后的结果文件, 仅保存 7 日, 超过时限的文件会自动删除, 请尽快下载转换后的结果文件.

您也可以在转换下载结果后, 通过删除任务接口对该任务的所有文件进行删除, 减少文件在服务器上的保存时间.

7. 其他说明

上传 PDF 大小限制

单文件不超过 200MB

接口常见错误消息说明

错误	原因
File too large	上传超出限制
Task not found	task_id 无效或任务已删除