API reference

Authentication

Programmatic requests are authenticated with an API key. Create one from API keys in your dashboard. Send it in the X-API-KEY request header — this is the only accepted method. One key works for every service.

X-API-KEY: ofc_live_xxx

Never put your API key in a URL (e.g. ?api-key=...) — query strings are written in plain text to server access logs, proxy logs, and browser history, and are the single most common way API keys leak. Query parameter authentication is not supported: a request that sends the key only as ?api-key=... is rejected with 400 Bad Request.

Base URL

Services

Every service uses the same createTask / getTaskResult flow — only the inputs you send and the typed solution you get back differ. Captcha images are sent base64-encoded (strip any data:image/…;base64, prefix); the token service takes a proxy and options.

Ten more generic types (reCAPTCHA, hCaptcha, Turnstile, DataDome and others) are on the roadmap — see pricing for the full list. They aren’t solvable yet and have no API surface.

Submits a task for solving and holds its price (hold) from your balance. Returns a task id you poll with /getTaskResult. The same call serves every service — vary the type + inputs.

curl -X POST "https://oneforcaptcha.com/createTask" \
  -H "X-API-KEY: $KEY" \
  -d '{"type":"tiktok_whirl","inputs":{"inner_b64":"<base64>","outer_b64":"<base64>"}}'

# arkose_token (public_key + proxy)
curl -X POST "https://oneforcaptcha.com/createTask" \
  -H "X-API-KEY: $KEY" \
  -d '{"type":"arkose_token","inputs":{"public_key":"XXXXXXXX-....","proxy":"http://user:pass@host:port"}}'

# 200
{ "task_id": "task_a1b2c3" }

Returns the current status of a task. Poll every 1–2 seconds until status is "ready". The charge is captured only once the task is solved; if it fails or expires, the hold is released.

curl "https://oneforcaptcha.com/getTaskResult?task_id=task_a1b2c3" -H "X-API-KEY: $KEY"

# 200 (still working)
{ "status": "processing", "solution": null }

# 200 (solved — captcha)
{ "status": "ready", "solution": { "index": 2, "final_x": 184, "drag_width": 260 } }

# 200 (solved — arkose_token)
{ "status": "ready", "solution": { "ok": true, "token": "…|sup=1", "finalized": true, "attempts": 2, "duration_seconds": 8.4 } }

Returns your current prepaid balance.

curl -H "X-API-KEY: $KEY" "https://oneforcaptcha.com/getBalance"

# 200
{ "balance": 42.50, "currency": "USD" }

Captcha

tiktok_whirl, tiktok_slide, tiktok_3d · from $0.80 / 1000

Submit a TikTok captcha image and get back typed click/drag coordinates you replay in the challenge.

Arkose FunCaptcha

arkose_token · from $0.80 / 1000

Solve the Uber device/session challenge and return a usable auth token. Bring your own public proxy per task; the token is returned finalized and ready to use.