API Keys, Webhooks, and Async Tasks

Developer API + Automation

Use this dashboard to manage account-level API access, inspect endpoint contracts, test webhook-ready automation setups, and review recent async task activity without leaving the browser.

API key rotation active API-auth async submit active Webhook callbacks active Preset library active Usage dashboard active Async task visibility active
Workflow snapshot
Rotate user-scoped API keys, inspect example requests, and keep integration settings in one account dashboard.
Async processing endpoints can be paired with webhook callbacks for terminal task events.
Saved presets reduce repeat setup for common automation flows and callback tests.

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.
Rotation invalidates the previous key immediately.
Requests tracked
0
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
Validate the current user-owned API key before plugin-side processing calls.
POST User API key
This is the live key-backed surface already connected to users.api_key.
curl -X POST 'https://snipinsta.app/api/wordpress-plugin/auth/validate' \
+  -H 'Accept: application/json' \
+  -F "api_key=YOUR_API_KEY"
WordPress plugin usage report
Report plugin-side usage against the same user API key and increment developer-facing counters.
POST User API key
Useful as the first real key-usage signal while the broader Developer API suite is still private.
curl -X POST 'https://snipinsta.app/api/wordpress-plugin/usage/report' \
+  -H 'Accept: application/json' \
+  -F "api_key=YOUR_API_KEY" \
+  -F 'tool=rm-bg' \
+  -F 'count=1'
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
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
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
Optional. When present, the async task worker will POST task status to this URL on selected terminal events.
Used to sign the callback payload with the `X-Snipinsta-Signature` header.
Callback events
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
0
Success rate
n/a
Avg duration
n/a
Heavy calls
0

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.

Was this helpful?

Your feedback improves our tools