ConvertCraft API Documentation

Integrate ConvertCraft’s file conversion capabilities into your applications via our REST API. Process images, PDFs, audio, video, and text through simple HTTP requests.

Base URL: https://api.convert-craft.com
OpenAPI spec: /openapi.yaml
RapidAPI: Subscribe on RapidAPI — the fastest way to get started.
Need help? Join our Discord

Authentication

API access requires a valid API key sent via the x-api-key header. If you access the API through RapidAPI, you also need the x-rapidapi-proxy-secret header. Keys are available to ConvertCraft Pro subscribers or through RapidAPI subscriptions.

Getting Started (RapidAPI)

Subscribe on RapidAPI and use RapidAPI’s built-in code snippets. The examples below are copy/paste templates — replace YOUR_API_KEY and YOUR_PROXY_SECRET with the values shown in RapidAPI.

1) Health check (GET /status)

curl -s \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-rapidapi-proxy-secret: YOUR_PROXY_SECRET" \
  https://api.convert-craft.com/status

2) Simple JSON tool (POST /slugify)

curl -s -X POST \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-rapidapi-proxy-secret: YOUR_PROXY_SECRET" \
  -d '{"text":"Hello World!"}' \
  https://api.convert-craft.com/slugify

3) File tool example (POST /image-convert)

File endpoints download from the sourceUrl field. Use a direct URL that returns HTTP 200 (this API intentionally does not follow redirects).

curl -s -X POST \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "x-rapidapi-proxy-secret: YOUR_PROXY_SECRET" \
  -d '{"sourceUrl":"https://example.com/photo.png","outputFormat":"webp"}' \
  https://api.convert-craft.com/image-convert \
  --output photo.webp

Endpoint Categories

The API provides endpoints grouped by conversion type:

Image Processing — Convert, resize, and optimize images (JPG, PNG, WebP, AVIF, HEIC, SVG, GIF, TIFF, BMP, ICO)
PDF Tools — Convert, merge, split, compress, and rasterize PDFs
Audio Tools — Convert between MP3, WAV, OGG, AAC, FLAC, M4A formats
Video Tools — Convert MP4, WebM, MKV, MOV, AVI, extract audio from video
Text Utilities — Slugify, hash, encode/decode, and other text operations
Crypto Tools — Hashing, encoding, and cryptographic utilities
System — Health check, status, and API metadata

For the full list of endpoints with request/response schemas, see the OpenAPI spec.

Rate Limits

Free tier: 10 requests per minute
Pro tier: 100 requests per minute
Enterprise: Custom limits available on request

Public endpoints are rate-limited per IP. Subscribers via RapidAPI receive higher limits.

Error Handling

All errors return JSON with a consistent structure:

{
  "error": "short_code",
  "message": "Human-readable description"
}

Common HTTP status codes:

400 — Bad request (missing or invalid parameters)
401 — Unauthorized (missing or invalid API key)
403 — Forbidden (invalid proxy secret or insufficient permissions)
429 — Rate limit exceeded
500 — Internal server error

Support

For API questions, bug reports, or feature requests, email [email protected] or join our Discord community.

CONVERTCRAFT V3.0 THE NEXT GENERATION