Redaction, wired into your product

Create a key from your Business Dashboard or Account page, then send it as a bearer token on every request:

Authorization: Bearer scanon_your_api_key

Keys that are missing, malformed, or revoked get a 401.

On 200, the response body is the redacted image as raw image/png bytes - not JSON. The X-Image-Credits-Remaining header reports your balance after the call. On any other status, the body is JSON - see Errors below.

encryption_mode="cryptographic" AES-scrambles each detected region with a fresh, never-stored key before blurring on top - the original pixels are unrecoverable, not just visually hidden. It costs 2 credits instead of 1; an unrecognized value is rejected with 400 rather than silently falling back to normal blur.

# curl's -o writes the response body to disk no matter the status code.
# Write to a temp file first and only keep it if the status was 200 - on
# error the body is JSON (e.g. {"detail": "Insufficient credits"}), not a PNG.
STATUS=$(curl -s -o /tmp/scanon_response -w "%{http_code}" \
  -X POST https://api.scanon.ai/v1/images \
  -H "Authorization: Bearer scanon_your_api_key" \
  -F "file=@photo.jpg" \
  -F "detect_faces=true" \
  -F "detect_plates=false" \
  -F "detect_tattoos=false" \
  -F "encryption_mode=normal")
# Change encryption_mode to "cryptographic" for AES-scrambled (irreversible)
# redaction - costs 2 image credits instead of 1.

if [ "$STATUS" -eq 200 ]; then
  mv /tmp/scanon_response redacted.png
  echo "Saved redacted.png"
else
  echo "Request failed with status $STATUS:"
  cat /tmp/scanon_response
  exit 1
fi

# Requires jq (https://jqlang.org) for JSON parsing.
API_KEY="scanon_your_api_key"

JOB=$(curl -s -X POST https://api.scanon.ai/v1/videos \
  -H "Authorization: Bearer $API_KEY" \
  -F "file=@video.mp4" \
  -F "encryption_mode=normal")
JOB_ID=$(echo "$JOB" | jq -r '.job_id')
echo "Submitted job $JOB_ID"

# Poll every 4s with a sensible max wait - never a tight loop
POLL_INTERVAL=4
MAX_WAIT=300
WAITED=0
STATUS="queued"

while [ "$STATUS" != "done" ] && [ "$STATUS" != "failed" ] && [ "$STATUS" != "cancelled" ]; do
  sleep "$POLL_INTERVAL"
  WAITED=$((WAITED + POLL_INTERVAL))
  if [ "$WAITED" -ge "$MAX_WAIT" ]; then
    echo "Timed out waiting for job $JOB_ID"
    exit 1
  fi

  POLL=$(curl -s "https://api.scanon.ai/v1/videos/$JOB_ID" -H "Authorization: Bearer $API_KEY")
  STATUS=$(echo "$POLL" | jq -r '.status')
  echo "status=$STATUS progress=$(echo "$POLL" | jq -r '.progress')"
done

if [ "$STATUS" != "done" ]; then
  echo "Job did not complete: $(echo "$POLL" | jq -r '.error')"
  exit 1
fi

# Single fetch only - a second call to /result returns 410
HTTP_STATUS=$(curl -s -o redacted.mp4 -w "%{http_code}" \
  "https://api.scanon.ai/v1/videos/$JOB_ID/result" \
  -H "Authorization: Bearer $API_KEY")

if [ "$HTTP_STATUS" -eq 200 ]; then
  echo "Saved redacted.mp4"
else
  echo "Fetch failed ($HTTP_STATUS) - result may have expired or already been retrieved"
  exit 1
fi

Note: detect_faces/detect_plates/detect_tattoos apply to images only. Video submissions currently redact every class your pipeline supports (faces, plates, screens) regardless of these flags - per-request filtering for video is planned but not yet wired up.

Video limits are intentionally capped near total processing capacity, so they won't move much even on higher tiers. Exceeding your limit returns 429 with a Retry-After header (seconds to wait) plus X-RateLimit-Limit and X-RateLimit-Remaining. A 429 is checked before credits are deducted, so a throttled request never costs you a credit.

Error bodies always look like this - check the status code before treating the response body as a result:

{
  "detail": "Insufficient credits"
}

• API calls draw from the same credit balance as the web app - there's no separate API pool.
• Images cost 1 credit, or 2 credits when encryption_mode="cryptographic".
• Videos cost 1 credit, or 2 credits when encryption_mode="cryptographic".
• Credits are deducted atomically before processing starts. If an image redaction fails unexpectedly (500), the credits charged for that call are automatically refunded - 2 for cryptographic mode, 1 otherwise.
• A 402 (insufficient credits) or 429 (rate limited) never deducts a credit.

• Once a job reaches status: "done", the redacted video is held for 10 minutes.
• GET /v1/videos/{job_id}/result deletes the cached file immediately after it streams the response - fetch it once and save it. A second call (or a call after the 10-minute window) returns 410.
• Jobs that go more than ~2 minutes without a status poll are treated as abandoned and cancelled - keep polling every few seconds until you see a terminal status.