# API Reference

Complete reference for all CaptchaSolv endpoints.

# Base URL

https://v1.captchasolv.com

Endpoint	Method	Description
`/health`	GET	Check API status
`/supportedTypes`	GET	List supported captcha types
`/createTask`	POST	Create async solving task
`/getTaskResult`	POST	Get task result (polling)
`/solve`	POST	Sync solving (recommended)
`/getBalance`	POST	Check account balance

All POST requests must use JSON body with Content-Type: application/json header.

{
  "clientKey": "YOUR_API_KEY",
  "task": {
    "type": "TaskType",
    "websiteURL": "https://example.com",
    ...
  }
}

All responses are JSON with the following structure:

{
  "errorId": 0,
  "status": "ready",
  "solution": {
    "token": "...",
    "userAgent": "..."
  }
}

{
  "errorId": 1,
  "errorCode": "ERROR_INVALID_REQUEST",
  "errorDescription": "Detailed error message"
}

Parameter	Type	Required	Description
`clientKey`	string	✅	Your API key
`task`	object	✅	Task configuration
`task.type`	string	✅	Captcha type (see Supported Types)
`task.websiteURL`	string	✅	Target website URL
`task.websiteKey`	string	⚠️	Site key (required for most types)
`task.proxy`	string	❌	Proxy in format `protocol://user:pass@host:port`

Field	Type	Description
`token`	string	Captcha token (reCAPTCHA, Turnstile, GeeTest)
`userAgent`	string	User agent used during solve
`cookie`	string	Cookie value (DataDome, Kasada)
`sensor`	string	Sensor data (Akamai)

Endpoints Reference

endpoints/

Error Codes

errors/