Skip to content

API reference

Endpoints, envelopes, and exact request shapes.

The production API is available at:

https://api.uncaptcha.io/v1

Endpoints

Method Path Purpose
POST /task/execute Execute any supported CAPTCHA or anti-bot task.
GET /balance/get Return the pay-as-you-go account balance.
GET /key/info Check that an API key works and return its type, status, and limits.

All endpoints accept authentication through X-Api-Key.

Response envelope

Successful responses contain success: true and a data object:

{
  "success": true,
  "data": {}
}

Errors contain success: false and a human-readable message:

{
  "success": false,
  "message": "X-Api-Key header is missing"
}

See Execute task for the challenge endpoint, Retrieve balance for the balance endpoint, or Retrieve key info to check a key.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close