Skip to main content

Find your next tool

Docs/Getting started/API quickstart: convert your first file
Getting started

API quickstart: convert your first file

Create an API key, send a file, wait for the job and download the result — with copy-paste requests.

Short answer

Create a key in Dashboard → API & keys, then send POST https://maxscanner.app/api/v1/jobs/ with a public file URL, a filename and the target format. The API returns a jobId straight away; poll GET /api/v1/jobs/{jobId}/ every few seconds until status is "completed", then download output.downloadUrl within five minutes.

Quickstart

  1. 1Open Dashboard → API & keys, choose Create API key, tick "Process files" and copy the key (it is shown once).
  2. 2Store the key in an environment variable such as MAXSCANNER_API_KEY — never in client-side code.
  3. 3POST /api/v1/jobs/ with url, filename and format. Keep the jobId from the 202 response.
  4. 4GET /api/v1/jobs/{jobId}/ every 2–10 seconds until status is completed or failed.
  5. 5Download output.downloadUrl straight away: the signed link expires after five minutes.

Before you start

Every request goes to https://maxscanner.app/api/v1/ and sends the key as a Bearer token. Request URLs end with a slash: a URL without it gets a 308 redirect that most HTTP clients follow, but sending the slash saves a round trip.

The Free plan allows 10 requests a day and 100 a month, which is enough to build and test an integration. Paid plans use monthly credits instead; each endpoint costs 0 to 3 credits.

  • Base URL: https://maxscanner.app/api/v1/
  • Header: Authorization: Bearer <your key>
  • Body: JSON with Content-Type: application/json
  • Files: up to 50 MB through URL import or direct upload

Convert a Word file to PDF

The jobs endpoint picks the right processor from the input and output formats. Pass a public URL and the server downloads the file itself when you create the job (up to 50 MB within 30 seconds; redirects are not followed, so use the final file link); for private files use a direct upload and pass sourceKey instead (see the Files and uploads guide). Add an Idempotency-Key header so that a retried request never creates a second job.

curl -X POST 'https://maxscanner.app/api/v1/jobs/' \
  -H "Authorization: Bearer $MAXSCANNER_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: quickstart-0001' \
  -d '{ "url": "https://example.com/report.docx", "filename": "report.docx", "format": "pdf" }'

Wait for the result

Jobs are asynchronous so that large files never hold your HTTP connection open. Poll the status URL, starting at about 2 seconds and backing off to 10 seconds. A small Office file usually finishes in under 20 seconds; a 1080p video can take minutes. When status is completed, output carries the content type, the size in bytes and a signed downloadUrl.

curl 'https://maxscanner.app/api/v1/jobs/6f0c2a6e-8a1b-4a53-9a0e-2b1f4c9d7e11/' \
  -H "Authorization: Bearer $MAXSCANNER_API_KEY"

Where to go next

Swap polling for a webhook when you process more than a handful of files, read the jobs guide for retry rules, and pick the feature guide that matches your job: OCR, PDF tools, images, media, or running a saved workflow.

Frequently asked questions

Do I need to install an SDK?

No. The API is plain HTTPS and JSON, so any language or no-code tool that can send an HTTP request works. The code examples guide has complete Node.js, Python, PHP and cURL versions.

How long is a download link valid?

Five minutes. Request the job status again to get a fresh link if it expires.

Is there a test mode?

Use the Free plan for testing: it has the same endpoints and limits each account to 10 requests a day and 100 a month.

Related guides