Docs/API Reference

API Reference

Complete reference for the PDF.beauty REST API endpoints.

Base URL

https://api.pdf.beauty

All API requests require a valid API key. Include it in the Authorization header:

Header

Authorization: Bearer pk_xxxxxxxxxxxxx

POST/v1/convert

Submit a PDF file for conversion to PPTX

fileFilerequiredThe PDF file to convert

optionsobjectConversion options (quality, etc.)

JSON

{
  "task_id": "task_abc123xyz",
  "status": "pending",
  "message": "Task created successfully"
}

GET/v1/tasks/:task_id

Get the status of a conversion task

task_idstringrequiredThe task ID returned from /v1/convert

JSON

{
  "task_id": "task_abc123xyz",
  "status": "completed",
  "progress": 100,
  "download_url": "/v1/download/task_abc123xyz"
}

GET/v1/download/:task_id

Download the converted PPTX file

task_idstringrequiredThe task ID of a completed conversion

Code	Description
`400`	Bad Request - Invalid parameters
`401`	Unauthorized - Invalid or missing API key
`402`	Payment Required - Insufficient credits
`404`	Not Found - Task or resource not found
`429`	Too Many Requests - Rate limit exceeded
`500`	Internal Server Error