POST
/api/v1/jobsCreate a processing job
Submit an asynchronous processing operation and receive a stable job identifier.
Authentication
API key
Scopes
jobs:create
Contract
API v1
Request
curl -X POST 'https://api.maxscanner.app/api/v1/jobs' \
-H 'Authorization: Bearer $MAXSCANNER_API_KEY' \
-H 'Content-Type: application/json' \
-H 'Idempotency-Key: unique-request-id' \
-d '{ "filename": "invoice.docx", "inputFormat": "docx", "format": "pdf", "sourceKey": "users/USER/uploads/invoice.docx" }'Request body
{ "filename": "invoice.docx", "inputFormat": "docx", "format": "pdf", "sourceKey": "users/USER/uploads/invoice.docx" }Response
{ "jobId": "job_123", "status": "queued", "statusUrl": "/api/v1/jobs/job_123" }Implementation notes
- Use Idempotency-Key for safe retries.
- The job may remain queued while workers are at capacity.
Try this endpoint
Use the API Playground to authenticate and test safely before wiring the endpoint into your application.
Open Playground →