ConvertCraft API 文档

通过 REST API 将 ConvertCraft 的文件转换能力集成到您的应用程序中。通过简单的 HTTP 请求处理图像、PDF、音频、视频和文本。

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

身份验证

大部分端点是公开的，无需身份验证。对于更高的速率限制或高级功能，请通过 RapidAPI 订阅以获得 API 密钥。

快速启动 (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

端点类别

The API provides endpoints grouped by conversion type:

图像处理 — Convert, resize, and optimize images (JPG, PNG, WebP, AVIF, HEIC, SVG, GIF, TIFF, BMP, ICO)
PDF 工具 — Convert, merge, split, compress, and rasterize PDFs
音频工具 — Convert between MP3, WAV, OGG, AAC, FLAC, M4A formats
视频工具 — Convert MP4, WebM, MKV, MOV, AVI, extract audio from video
文本工具 — Slugify, hash, encode/decode, and other text operations
加密工具 — Hashing, encoding, and cryptographic utilities
系统 — Health check, status, and API metadata

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

速率限制

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

公共端点每IP限制速率。订阅者通过RapidAPI获得更高的速率限制。

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.