Image Processing API

Background Removal API & Image Processing API

Call Snipinsta's background removal, OCR and image conversion from your own code. One API key, a single multipart POST, and either a direct binary response or an async task with a webhook callback when it finishes.

Background removal OCR text extraction Video to GIF Webhook callbacks Async task queue

Create a free account for an API key See API limits and pricing

Remove a background in one call

curl -X POST \
  https://snipinsta.app/api/processing-tasks/rm-bg \
  -H "X-API-Key: $SNIPINSTA_API_KEY" \
  -F "image=@product.jpg" \
  -F "webhook_url=https://you.example/hook"

Returns a task UUID immediately; poll /api/processing-tasks/{uuid}/status or let the webhook tell you when the transparent PNG is ready.

What the API does

Four processing endpoints run asynchronously: you POST a file, get a task UUID back straight away, and either poll for status or receive a webhook. That shape exists because background removal and video work take seconds, not milliseconds, and holding an HTTP connection open for them is a bad deal for both sides.

Endpoint	What it does	File field
`POST /api/processing-tasks/rm-bg`	Removes the background and returns a transparent PNG.	`image`
`POST /api/processing-tasks/ocr`	Extracts text from images and scanned pages.	`images`
`POST /api/processing-tasks/gif-maker`	Builds an animated GIF from a set of frames.	`images`
`POST /api/processing-tasks/gif-from-video`	Converts a video clip into an animated GIF.	`video`

Authentication

Send your key as an X-API-Key header, or as an api_key form field if a header is inconvenient. Keys are per-account and can be rotated at any time from the dashboard below.

Getting the result

GET /api/processing-tasks/{uuid}/status — poll for progress and terminal state.
GET /api/processing-tasks/{uuid}/result — fetch the finished file.
Or pass webhook_url on submit, optionally with webhook_secret and webhook_events, and be told instead of asking.

You need an account to get a key. Sign up free, then your key and usage dashboard appear on this page. Rate limits by plan are on the pricing page.

API access is limited on free plans.

Free accounts include up to 20 API requests per month. Sign in to track usage and unlock higher limits.

API Key Control

Rotate the current user-owned key and use it against the live developer endpoints below, including async task submission and polling.

Current account only

Sign in to rotate API keys or save automation presets. Endpoint contracts and page documentation remain viewable without signing in.

Current API key

Rotation invalidates the previous key immediately.

Requests tracked

Lifetime developer-facing request count for this account.

Last API activity

No recent usage

Based on the user-level API activity timestamp.

Automation layer

Callbacks + presets active

Async submissions can include webhook callbacks, and this dashboard can store reusable endpoint plus callback combinations.

Current Endpoint Contracts

These are the live contracts available from the current developer dashboard.

Real route references

WordPress plugin key validation

Bootstrap or validate a site-scoped WordPress plugin installation token.

POST Bootstrap API key or installation token

URL: https://snipinsta.app/api/wordpress-plugin/auth/validate

Send the account API key for first connection or reconnect. The response includes data.installation.token once; the plugin stores that site-scoped token and uses it on later requests.

curl -X POST 'https://snipinsta.app/api/wordpress-plugin/auth/validate' \
+  -H 'Accept: application/json' \
+  -F "api_key=YOUR_API_KEY" \
+  -F 'site_url=https://example.com' \
+  -F 'plugin_version=1.3.0'

# Later validation can use the site token only:
curl -X POST 'https://snipinsta.app/api/wordpress-plugin/auth/validate' \
+  -H 'Accept: application/json' \
+  -F 'installation_token=sio_SITE_TOKEN' \
+  -F 'site_url=https://example.com'

WordPress plugin usage report

Reserve/report plugin-side usage against the connected WordPress site.

POST Installation token preferred

URL: https://snipinsta.app/api/wordpress-plugin/usage/report

Usage responses include usage_log_id. If the plugin reserves quota but later skips local mutation because the optimized file is not smaller, call the reconciliation endpoint.

curl -X POST 'https://snipinsta.app/api/wordpress-plugin/usage/report' \
+  -H 'Accept: application/json' \
+  -F 'installation_token=sio_SITE_TOKEN' \
+  -F 'site_url=https://example.com' \
+  -F 'action=manual_optimize' \
+  -F 'file_count=1' \
+  -F 'metadata[reservation]=1'

WordPress plugin usage reconciliation

Release a prior plugin usage reservation when no local optimization was applied.

POST Installation token preferred

URL: https://snipinsta.app/api/wordpress-plugin/usage/reconcile

Accepted reasons: not_optimized, local_error, not_smaller. Reconciled logs no longer count toward monthly plugin usage.

curl -X POST 'https://snipinsta.app/api/wordpress-plugin/usage/reconcile' \
+  -H 'Accept: application/json' \
+  -F 'installation_token=sio_SITE_TOKEN' \
+  -F 'site_url=https://example.com' \
+  -F 'usage_log_id=123' \
+  -F 'reason=not_smaller'

Async processing submit

Queue a heavy processing job and receive task polling URLs with an HTTP 202 response.

POST User API key or signed-in session

URL: https://snipinsta.app/api/processing-tasks/rm-bg

Supported async endpoints right now: rm-bg, ocr, gif-from-video, gif-maker. API clients can authenticate with the X-API-Key header and optionally send webhook_url, webhook_events[], and webhook_secret for task callbacks.

curl -X POST 'https://snipinsta.app/api/processing-tasks/rm-bg' \
+  -H 'Accept: application/json' \
+  -H 'X-API-Key: YOUR_API_KEY' \
+  -F 'image=@/absolute/path/to/source.png' \
+  -F 'webhook_url=https://example.com/hooks/snipinsta' \
+  -F 'webhook_events[]=succeeded' \
+  -F 'webhook_secret=shared-secret'

Async task polling + result download

Poll task state and fetch the final result URL once the queued job succeeds.

GET Same browser session, signed-in user, or API key

URL: https://snipinsta.app/api/processing-tasks/TASK_ID/status

Callbacks now fire on succeeded and/or failed terminal states when a webhook URL is supplied. Polling remains the fallback contract, and API clients can still query the same URLs with the X-API-Key header.

curl -H 'X-API-Key: YOUR_API_KEY' 'https://snipinsta.app/api/processing-tasks/TASK_ID/status'

# then download
curl -L -H 'X-API-Key: YOUR_API_KEY' 'https://snipinsta.app/api/processing-tasks/TASK_ID/result' -o result.bin

Saved Automation Presets

Save endpoint + callback combinations for repeated API runs and callback tests.

Account presets

Async endpoint

Auth mode

Webhook callback URL

Optional. When present, the async task worker will POST task status to this URL on selected terminal events.

Webhook secret

Used to sign the callback payload with the `X-Snipinsta-Signature` header.

Callback events

Succeeded

Failed

Operator notes

Save repeatable endpoint + callback combinations for this account.

Generated request preview

Webhook callback payload

Terminal task callbacks send JSON with task identifiers, status URLs, and optional result URLs for succeeded jobs.

{
  "event": "processing-task.succeeded",
  "task_id": "TASK_ID",
  "endpoint": "rm-bg",
  "status": "succeeded",
  "status_url": "https://snipinsta.app/api/processing-tasks/TASK_ID/status",
  "result_url": "https://snipinsta.app/api/processing-tasks/TASK_ID/result",
  "output_filename": "result.png"
}

Preset Library

Apply or delete saved automations

No saved automation presets yet.

Recent API Request Logs

Latest tracked `api_usage_logs` rows for this account.

0 recent rows

No API usage logs recorded for this account yet.

Usage Snapshot

Total

Success rate

n/a

Avg duration

n/a

Heavy calls

Async Task Queue

0 tracked

Queued0

Processing0

Succeeded0

Failed0

Currently enabled async endpoints:

rm-bg · Background removal ocr · OCR extraction gif-from-video · GIF from video gif-maker · GIF maker

Recent Async Tasks

0 recent

No async tasks recorded for the current tracked endpoints yet.

How Teams Use This Page

This dashboard is useful when you need a fast view of the current API contract, want to rotate credentials without opening the database, or need a repeatable webhook configuration for async image-processing jobs.

Rotate the key whenever a credential is shared too broadly, a team member leaves, or you want to move an integration to a new environment safely.

Presets help when the same endpoint, auth mode, and webhook combination is used repeatedly across staging, QA, or partner integrations.

Recent tasks show which endpoints are active, whether jobs succeeded or failed, and where callback or result URLs are being generated for downstream automation.