API Docs Overview
ImageHQ uses a compact asynchronous API surface. Each processing endpoint accepts multipart/form-data with files and a JSON request payload.
Core conventions
- POST endpoints queue jobs and return a queued response.
- Poll /v1/jobs/{job_id} for lifecycle status updates.
- Use `Idempotency-Key` for safe retries.
- `dry_run=true` validates requests without job creation.
- Completed jobs include outputs, stages, warnings, and retention details.
Endpoint index
Image Convert API (POST /v1/convert)
Image Optimization API (POST /v1/optimize)
Image Transform API (POST /v1/transform)
Image Filter API (POST /v1/filter)
Image Compose API (POST /v1/compose)
Image Metadata API (POST /v1/metadata)
Image OCR API (POST /v1/ocr)
Image Document API (POST /v1/document)
Image Enhance API (POST /v1/enhance)
Image Pipeline API (POST /v1/pipeline)
Image Batch API (POST /v1/batch)