PDF 解析 API
解析项目文件中的 PDF,并按需读取解析结果或页面内容。
基础信息
- 基础路径:
/projects/:projectId/pdf-parse - 认证方式:JWT Bearer Token 或 API Key(combinedAuth)。需要项目访问权限。
端点
补充端点
本节补充 plans/need-update-api.md 中尚未覆盖到 docs-site 的接口。端点标题保持严格的 METHOD /path 格式,便于后台文档覆盖率服务识别。
POST /projects/:projectId/pdf-parse
提交 PDF 解析任务或执行解析。
认证:JWT Bearer Token 或 API Key(combinedAuth)。需要项目访问权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
请求:请求体按业务使用 multipart/form-data 或 JSON;上传文件时字段名以对应前端调用为准。
响应:成功时返回创建或更新后的资源对象,或 { "success": true }。
常见错误:400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500。
POST /projects/:projectId/pdf-parse/read
读取已解析 PDF 的文本或页面内容。
认证:JWT Bearer Token 或 API Key(combinedAuth)。需要项目访问权限。 路径参数
| 参数 | 说明 |
|---|---|
projectId | 项目 ID |
请求:请求体按业务使用 multipart/form-data 或 JSON;上传文件时字段名以对应前端调用为准。
响应:成功时返回创建或更新后的资源对象,或 { "success": true }。
常见错误:400 参数非法,401 未认证,403 权限不足,404 资源不存在;服务端或上游异常返回 500。