Developer Documentation

Filemazing API Documentation

Use the Filemazing API to automate file conversion and processing workflows for PDF, image, archive, audio, and security-related tasks without building the infrastructure yourself.

Auth

Bearer or X-API-Key

Every request must include a valid user API key.

Estimate first

Preview token cost

Estimate endpoints help validate input and expected usage before processing.

Response

Download URL on success

Successful sync responses return a result URL plus token details.

Step 1

Generate an API key

Create a key from your account area and keep it on the server side, never in public frontend code.

Step 2

Estimate the job

Call an estimate endpoint first to preview token cost and confirm the request shape is valid.

Step 3

Send the processing request

Submit the real job and use the returned download URL inside your product or internal workflow.

Who this API is built for

SaaS products

Offer user-facing conversions and processing steps without building your own file pipeline from scratch.

Internal tools

Automate document, image, or archive handling inside ops and support workflows.

Content systems

Generate web-ready assets, compress uploads, and normalize media formats.

Privacy-aware workflows

Strip metadata or encrypt files before they move to another system or customer handoff.

Integration notes

Use direct HTTP or HTTPS file URLs that remain reachable for the duration of the job.

Prefer short-lived signed URLs for sensitive sources rather than broadly exposed assets.

Design retries with small backoff windows around throttling and temporary upstream failures.

Keep estimate and processing calls inside a predictable workflow so token usage is understandable to your team and users.

Quick Start Checklist

Use direct HTTP/HTTPS URLs that are available to our processing servers for the duration of the job.
For sensitive files, prefer short-lived signed URLs instead of broadly accessible links.
Per request limits apply and may vary by tool and file type.
Send your API key with `Authorization: Bearer ...` or `X-API-Key`.
Call `/estimate` first to preview token cost.
Then call the processing endpoint.
Successful responses return a `download_url` to the generated output.

API Base Path

Use this base path as the starting point for public API requests, then append the tool endpoint you need such as `/pdf-to-image`, `/merge-pdf`, or `/compress-image`.

https://your-domain.example/api/v1

Developer FAQ

What is the Filemazing API used for? +

The Filemazing API lets developers automate file conversions and related processing tasks such as PDF to image, document merging, image compression, archive extraction, metadata scrubbing, and file encryption.

How does authentication work? +

Each request uses an API key sent with an Authorization Bearer header or X-API-Key header. Keys are generated from the account area and should be treated like secrets.

Should I call estimate endpoints first? +

Yes. Estimate endpoints are the recommended first call because they preview token usage and validate whether a request is likely to succeed before you spend tokens on processing.