API Reference

Convertaverse API

Integrate powerful file conversion capabilities into your applications with our RESTful API.

Quick Start

Get started in minutes

1Get your API Key

Create an API key from your dashboard. Keep it secure - it provides access to your account.

2Make your first request

curl -X POST "https://convertaverse-production.up.railway.app/api/convert/image" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@photo.png" \
  -F "output_format=webp"

3Download the result

The API returns a JSON response with a download_url. Use it to download your converted file.

Authentication

All API requests require authentication using your API key. Include it in the request header:

X-API-Key: YOUR_API_KEY

Secure

Keys are hashed and stored securely

Rate Limited

100 requests per minute

Expiration

Optional key expiration

Response Format

Successful conversion response:

{
  "success": true,
  "filename": "converted_file.webp",
  "download_url": "/api/download/abc123...",
  "original_size": 1024000,
  "converted_size": 256000,
  "credits_used": 1
}

Error response:

{
  "success": false,
  "error": "Insufficient credits",
  "credits_needed": 5,
  "credits_available": 2
}

Endpoints

Image Conversion

POST/api/convert/image1 credit

Convert images between formats (PNG, JPG, WebP, GIF, BMP, HEIC)

Parameters

fileFilerequired- The image file to convert

output_formatstringrequired- Target format (png, jpg, webp, gif, bmp)

Example

curl -X POST "https://convertaverse-production.up.railway.app/api/convert/image" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@image.png" \
  -F "output_format=webp"

POST/api/convert/image/resize1 credit

Resize images to specific dimensions

Parameters

fileFilerequired- The image file to resize

widthnumber- Target width in pixels

heightnumber- Target height in pixels

maintain_aspect_ratioboolean- Maintain aspect ratio (default: true)

Example

curl -X POST "https://convertaverse-production.up.railway.app/api/convert/image/resize" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@image.png" \
  -F "width=800" \
  -F "height=600"

POST/api/convert/image/crop1 credit

Crop images to specific region

Parameters

fileFilerequired- The image file to crop

xnumberrequired- Left coordinate of crop box

ynumberrequired- Top coordinate of crop box

widthnumberrequired- Width of crop box in pixels

heightnumberrequired- Height of crop box in pixels

Example

curl -X POST "https://convertaverse-production.up.railway.app/api/convert/image/crop" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@image.png" \
  -F "x=100" \
  -F "y=100" \
  -F "width=500" \
  -F "height=300"

POST/api/convert/image/remove-background2 credits

Remove background from images (AI-powered)

Parameters

fileFilerequired- The image file (PNG, JPG, WebP)

Example

curl -X POST "https://convertaverse-production.up.railway.app/api/convert/image/remove-background" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@photo.jpg"

Audio Conversion

POST/api/convert/audio3 credits

Convert audio files between formats (MP3, WAV, OGG, FLAC, AAC, M4A)

Parameters

fileFilerequired- The audio file to convert

output_formatstringrequired- Target format (mp3, wav, ogg, flac, aac)

Example

curl -X POST "https://convertaverse-production.up.railway.app/api/convert/audio" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@audio.wav" \
  -F "output_format=mp3"

Video Conversion

POST/api/convert/video5 credits

Convert video files between formats (MP4, AVI, MOV, WebM, MKV)

Parameters

fileFilerequired- The video file to convert

output_formatstringrequired- Target format (mp4, avi, mov, webm, mkv)

Example

curl -X POST "https://convertaverse-production.up.railway.app/api/convert/video" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@video.mov" \
  -F "output_format=mp4"

POST/api/convert/video-to-audio3 credits

Extract audio from video files

Parameters

fileFilerequired- The video file

output_formatstringrequired- Audio format (mp3, wav)

Example

curl -X POST "https://convertaverse-production.up.railway.app/api/convert/video-to-audio" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@video.mp4" \
  -F "output_format=mp3"

POST/api/convert/video-to-gif5 credits

Convert video clips to animated GIF

Parameters

fileFilerequired- The video file (MP4, AVI, MOV, WebM)

fpsnumber- Frames per second (default: 10, range: 5-30)

widthnumber- Output width in pixels (default: 480, max: 1280)

start_timenumber- Start time in seconds

durationnumber- Duration in seconds (max: 30)

Example

curl -X POST "https://convertaverse-production.up.railway.app/api/convert/video-to-gif" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@video.mp4" \
  -F "fps=15" \
  -F "width=320" \
  -F "duration=5"

Document Conversion

POST/api/convert/document2 credits

Convert documents (PDF to Word, Word to PDF, etc.)

Parameters

fileFilerequired- The document file to convert

output_formatstringrequired- Target format (pdf, docx, txt)

Example

curl -X POST "https://convertaverse-production.up.railway.app/api/convert/document" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@document.docx" \
  -F "output_format=pdf"

PDF Tools

POST/api/convert/pdf1 per page credit

Convert PDF to images

Parameters

fileFilerequired- The PDF file

output_formatstringrequired- Image format (png, jpg)

pagesstring- Page selection (e.g., '1-3', 'all')

Example

curl -X POST "https://convertaverse-production.up.railway.app/api/convert/pdf" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@document.pdf" \
  -F "output_format=png" \
  -F "pages=1-3"

POST/api/convert/pdf-merge1 per file credit

Merge multiple PDF files into one

Parameters

filesFile[]required- PDF files to merge (multiple)

Example

curl -X POST "https://convertaverse-production.up.railway.app/api/convert/pdf-merge" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "files=@doc1.pdf" \
  -F "files=@doc2.pdf" \
  -F "files=@doc3.pdf"

POST/api/convert/pdf-split1 credit

Extract specific pages from a PDF

Parameters

fileFilerequired- The PDF file

pagesstringrequired- Pages to extract (e.g., '1,3,5-7')

Example

curl -X POST "https://convertaverse-production.up.railway.app/api/convert/pdf-split" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "file=@document.pdf" \
  -F "pages=1,3,5-7"

API Key Management

GET/api/api-keys0 credit

List all your API keys

Parameters

Example

curl -X GET "https://convertaverse-production.up.railway.app/api/api-keys" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

POST/api/api-keys0 credit

Create a new API key

Parameters

namestringrequired- Friendly name for the key

expires_in_daysnumber- Days until expiration (optional)

Example

curl -X POST "https://convertaverse-production.up.railway.app/api/api-keys" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name": "Production API Key"}'

GET/api/api-keys/{key_id}/stats0 credit

Get usage statistics for an API key

Parameters

key_idnumberrequired- The API key ID

daysnumber- Days to look back (default: 30, max: 90)

Example

curl -X GET "https://convertaverse-production.up.railway.app/api/api-keys/123/stats?days=30" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

GET/api/api-keys/{key_id}/usage0 credit

Get usage history for an API key

Parameters

key_idnumberrequired- The API key ID

limitnumber- Number of records (default: 50)

offsetnumber- Skip records (for pagination)

Example

curl -X GET "https://convertaverse-production.up.railway.app/api/api-keys/123/usage?limit=20" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

DELETE/api/api-keys/{key_id}0 credit

Delete an API key

Parameters

key_idnumberrequired- The API key ID

Example

curl -X DELETE "https://convertaverse-production.up.railway.app/api/api-keys/123" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Need more credits?

Purchase credit bundles from our pricing page. Credits never expire!

View Pricing