API Documentation

Integrate DocPort directly into your application. Convert Apple documents automatically via REST API.

Authentication

All API endpoints require an API key in the X-API-Key header.

Example:

curl -X POST https://docport.juergenkoller.software/api/v1/convert \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@document.pages" \
  -F "output_format=docx"

Supported Formats

Endpoints

Convert File

POST /api/v1/convert

Converts an Apple file to the desired output format.

Parameters (multipart/form-data):

• file — The file to convert (.pages, .numbers, .key)
• output_format — Target format (optional, default: automatic)

Response:

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "queued",
  "status_url": "/api/v1/jobs/550e8400-e29b-41d4-a716-446655440000"
}

Get Job Status

GET /api/v1/jobs/{job_id}

Returns the current status of a conversion.

Status values: queued, processing, completed, failed

Response:

{
  "job_id": "550e8400-...",
  "status": "completed",
  "filename": "document.pages",
  "output_format": "docx",
  "created_at": "2026-02-26T12:00:00Z",
  "completed_at": "2026-02-26T12:00:05Z",
  "download_url": "/api/v1/jobs/550e8400-.../download"
}

Download Result

GET /api/v1/jobs/{job_id}/download

Downloads the converted file (only when status is completed).

Batch Conversion

POST /api/v1/batch

Converts up to 100 files in a single request.

Example:

curl -X POST https://docport.juergenkoller.software/api/v1/batch \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "files=@doc1.pages" \
  -F "files=@doc2.numbers" \
  -F "files=@presentation.key"

Get Batch Status

GET /api/v1/batch/{batch_id}

Download Batch as ZIP

GET /api/v1/batch/{batch_id}/download

Limits

• Max file size: 100 MB per file
• Rate limit: 100 requests/minute (single conversion)
• Rate limit: 10 requests/minute (batch)
• Max batch size: 100 files
• Files are automatically deleted after 24 hours