API v1 beta

API Documentation

The WordPDF Converter API lets developers create file conversion jobs, check job status, and view API usage. The current API is in beta mode. Conversion workers and paid production plans will be connected in the next phases.

View OpenAPI JSON Request API access

Authentication

Protected endpoints require an API key in the Authorization header.

Authorization: Bearer YOUR_API_KEY

Keep API keys private. Do not expose API keys in frontend JavaScript, public Git repositories, mobile apps, or client-side code.

Endpoints

Method	Endpoint	Auth	Description
GET	/api/v1/health	No API key required	Check whether the WordPDF Converter API is available.
POST	/api/v1/jobs	Requires API key	Create a new file conversion job in API beta mode.
GET	/api/v1/jobs/{id}	Requires API key	Read the status and details of a conversion job.
GET	/api/v1/usage	Requires API key	View recent API usage and rate limit information.

Health check

This endpoint is public and can be used to confirm the API is online.

curl https://word-to-pdf-converter.com/api/v1/health

Create a conversion job

Create a job by sending a tool name, source file name, and optional target format. In beta mode, this creates a job record. File upload and real conversion workers will be connected next.

curl https://word-to-pdf-converter.com/api/v1/jobs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tool": "pdf-to-word",
    "sourceFileName": "document.pdf",
    "targetFormat": "docx"
  }'

Example response

{
  "ok": true,
  "job": {
    "id": "job_abc123",
    "tool": "pdf-to-word",
    "sourceFileName": "document.pdf",
    "targetFormat": "docx",
    "status": "accepted"
  },
  "rateLimit": {
    "limit": 120,
    "remaining": 119,
    "resetAt": "2026-07-23T22:00:00.000Z"
  }
}

Check job status

curl https://word-to-pdf-converter.com/api/v1/jobs/JOB_ID \
  -H "Authorization: Bearer YOUR_API_KEY"

View API usage

curl https://word-to-pdf-converter.com/api/v1/usage \
  -H "Authorization: Bearer YOUR_API_KEY"

Supported tool names

These tool names are examples for the API beta. The final production API may add more tools and stricter validation.

pdf-to-wordword-to-pdfcompress-pdfmerge-pdfsplit-pdfjpg-to-pdfpng-to-pdfimage-compressvideo-compress

Beta limitations

- API keys are private and manually issued.
- Job creation currently stores beta job records.
- File upload and conversion workers are the next phase.
- Paid API billing is not enabled yet.