Developers
Plug IMAGICS into
your own system.
A small, predictable REST API. Send images, get structured JSON back, and let a signed webhook tell you when a batch is finished.
Quick start
One call. Clean fields.
Authenticate with your API key, post an image, and read the fields. Every field also comes with a confidence score, and uncertain results land in your team's review queue as usual.
API keys
Issued per company, rate-limited and revocable at any time.
JSON, CSV, Excel
Read results as JSON or download a batch as a file.
# Send one image and wait for the result
curl https://app.imagics.cloud/v1/scans?wait=true \
-H "Authorization: Bearer ak_live_…" \
-F "image=@slip.jpg"
# Response
{
"status": "done",
"fields": {
"receiver": "Emily Carter",
"organization": "Northwind Supplies",
"address": "1420 Market Street, Suite 300",
"city": "San Francisco",
"phone": "4155550142"
}
}Endpoints
Everything you need. Nothing you don't.
POST
/v1/scans Send one image. Add ?wait=true to get the result in the same call. POST
/v1/batches Send many images or a ZIP file as one batch. GET
/v1/batches List your recent batches. GET
/v1/batches/:id Progress and counts for one batch. GET
/v1/batches/:id/scans Every result in a batch, filterable by status. GET
/v1/batches/:id/export Download a batch as CSV or Excel. GET
/v1/scans/:id One result with its fields and confidence. GET
/v1/scans/:id/image The stored image of one scan. GET
/v1/credits Your current credit balance. Base URL https://app.imagics.cloud · Auth Authorization: Bearer <key>
# Send a whole batch (images or a ZIP)
curl https://app.imagics.cloud/v1/batches \
-H "Authorization: Bearer ak_live_…" \
-F "files=@day-14.zip"
# Later: download the results as Excel
curl -o results.xlsx \
"https://app.imagics.cloud/v1/batches/BATCH_ID/export?format=xlsx" \
-H "Authorization: Bearer ak_live_…"Webhooks
We call you when it's done.
Register an HTTPS address and IMAGICS sends a batch-completed event the moment the last image is read.
- Signed with HMAC-SHA256 so you can verify it came from us
- Sent only to public addresses, never to internal networks
- Rotate the signing secret whenever you want
Ready to
integrate?
API access is set up for your company account together with your keys, webhook and the full API reference.