File Converter
The File Converter API specifications and task parameters, supporting conversion between HTML, Image, Keynote, Markdown, PDF, PPT/PPTX, Word, and other formats.
API Endpoints
File conversion tasks are processed asynchronously. Use the two endpoints below to create and retrieve tasks. Click "Try it" on the right to open the interactive playground.
POST
/tools/tasks
Creates an asynchronous conversion task. Pass the corresponding converter tool identifier in type.
GET
/tools/tasks/:id
Queries the execution status of a conversion task and retrieves the final output download link via result.url.
Request Headers
| Header | Type | Required | Description |
|---|---|---|---|
Authorization |
String |
Yes | Bearer <YOUR_API_KEY> — API Key. |
Content-Type |
String |
Yes (POST) | Must be multipart/form-data. |
POST Body Parameters (Form Data)
| Parameter | Type | Required | Description |
|---|---|---|---|
files |
File |
Yes | Source file to be processed. Supports uploading multiple files. |
type |
String |
Yes | Task type identifier. For example: convertor.ppt2pdf. |
params |
String (JSON) |
No | JSON string of tool-specific parameters. Defaults to an empty JSON string "{}". |
notifyURL |
String |
No | Webhook callback URL to receive task status update notifications. |
Task Parameter Specifications
The specific task types, format requirements, file size limits, and custom parameters (params) for each File Converter tool are detailed below:
| Tool Name (UI Display) | Tool ID | Backend Task Type (type) | Accepted Extensions (accept) | File Size Limit | Special Parameters (params) |
|---|---|---|---|---|---|
| HTML to PNG | html2png | convertor.html2png | .html, .htm | 50 MB | {} *Supports directly pasting HTML code as file input* |
| HTML to PPTX | html2pptx | convertor.html2pptx | .html, .htm | 50 MB | {"needEmbedFonts": boolean} *Whether to embed fonts in the generated PPTX. Supports pasting HTML* |
| Image to WebP | image-convert-webp | image.convertWebp | image/* | 100 MB | {} |
| Keynote to HTML | keynote2html | convertor.keynote2html | .key | 300 MB | {} |
| Keynote to Image | keynote2image | convertor.keynote2image | .key | 300 MB | {} |
| Keynote to PDF | keynote2pdf | convertor.keynote2pdf | .key | 300 MB | {} |
| Markdown to Image | markdown2png | convertor.markdown2png | .md, .markdown | 10 MB | {} *Supports directly pasting Markdown text as file input* |
| PDF to Image | pdf2image | convertor.pdf2image | .pdf | 300 MB | {} |
| PPT to PPTX | ppt2pptx | convertor.ppt2pptx | .ppt | 300 MB | {} |
| PowerPoint to PDF | ppt2pdf | convertor.ppt2pdf | .ppt, .pptx | 300 MB | {} |
| PowerPoint to Image | ppt2image | convertor.ppt2image | .ppt, .pptx | 300 MB | {} |
| PowerPoint to Video | ppt2video | convertor.ppt2video | .ppt, .pptx | 300 MB | {} |
| Word to PDF | doc2pdf | convertor.doc2pdf | .doc, .docx | 300 MB | {} |