概览/API 参考

API 参考

PDF.beauty REST API 接口的完整参考指南。

基础 URL

https://api.pdf.beauty

身份认证

所有 API 请求都需要有效的 API 密钥。请将其包含在 Authorization 请求头中：

请求头
Authorization: pk_xxxxxxxxxxxxx

接口列表

POST/api/convert/submit

提交 PDF 文件进行 PPTX 转换

参数

fileFilerequiredThe PDF file to convert
maxPagesnumberMaximum pages to convert (optional)

响应

JSON
{
  "taskId": "task_abc123xyz",
  "status": "pending",
  "message": "Task created successfully"
}
GET/api/convert/tasks/{taskId}

获取转换任务的状态

参数

taskIdstringrequiredThe task ID returned from /api/convert/submit

响应

JSON
{
  "taskId": "task_abc123xyz",
  "status": "completed",
  "progress": 100,
  "currentStep": "Finished",
  "resultUrl": "/api/convert/tasks/task_abc123xyz/download",
  "totalPages": 10,
  "pagesToConvert": 10,
  "pagesConverted": 10,
  "creditsUsed": 10
}
GET/api/convert/tasks/{taskId}/download

下载转换后的 PPTX 文件

参数

taskIdstringrequiredThe task ID of a completed conversion
GET/api/convert/tasks

获取用户的转换任务列表（分页）

参数

pagenumberPage number (default: 1)
pageSizenumberItems per page (default: 20)

响应

JSON
{
  "tasks": [...],
  "page": 1,
  "pageSize": 20,
  "total": 100
}
GET/api/convert/credits

获取用户的额度信息

响应

JSON
{
  "userId": "user_123",
  "credits": 100,
  "lockedCredits": 0,
  "plan": "FREE",
  "freePagesRemaining": 3
}

错误代码

Code描述
400请求错误 - 参数无效
401未授权 - API 密钥无效或缺失
402需要付费 - 余额不足
404未找到 - 任务或资源不存在
429请求过多 - 已触发频率限制
500docsContent.apiRef.errors.e500