Developers

Scan from your own tools.

The same scan as the website, over HTTPS: send an image, get the result as JSON. Each API scan uses one scan of your monthly plan. Keys are created and revoked here.

Overview

Base URL and endpoints.

POST/api/scanScan one image. Multipart upload, JSON result.

GET/api/reports/{historyId}/pdfThe PDF audit report for a scan. Starter and Agency.

Base URL https://api.staimp.com · Authorization: X-Staimp-Key: <key> · Full reference in the OpenAPI specification.

API keys

A new key is shown once. Store it in your secrets manager.

Webhooks

Get notified when a scan finishes.

Example

Scan a file with curl.

# the key you created above
export STAIMP_API_KEY="<your key>"

curl -X POST "https://api.staimp.com/api/scan" \
  -H "X-Staimp-Key: $STAIMP_API_KEY" \
  -F "file=@harbour.png"

The file field takes one JPG, PNG or WebP image, 10 MB max. Every field is described in the OpenAPI specification.

{
  "score": 2, "compliance": "PASS", "risk": "MEDIUM",
  "triggeredRule": "R-ART50-DISCLAIMED",
  "provenance": { "c2pa": { "status": "present-valid" } },
  "ai": { "probability": 0.98 },
  "legal": { "engineVersion": "staimp-legal-v3" },
  "historyId": "…"
}

Excerpt of a scan response for an AI image whose Content Credentials declare it.