health
Check from a monitor or load balancer whether the AnySolver API can accept tasks. GET /health needs no API key and answers 200 when ready, 503 when not.
GET /health answers HTTP 200 with {"status": "ok"} when the API can accept tasks, and HTTP 503 when it cannot. It needs no API key. Act on the HTTP status code: unlike the other endpoints, which answer HTTP 200 for errors too, this one signals failure with its status.
https://api.anysolver.com /healthRequest
Send a GET request with no body and no clientKey.
curl https://api.anysolver.com/healthResponse body
| Field | Type | Required | Description |
|---|---|---|---|
status* | string | Yes |
Example: |
Example
A healthy API answers with HTTP 200:
{
"status": "ok"
}Unavailable
When the task store does not accept writes, the API cannot create tasks and the endpoint answers HTTP 503 with an error body. Take the instance out of rotation until it answers HTTP 200 again.
{
"errorId": 1,
"errorCode": "SERVICE_UNAVAILABLE",
"errorDescription": "Task store is not accepting writes."
}Related
POSTgetBalance
Read your organization balance in USD with getBalance. One balance pays for tasks on every provider, and checking it is free and needs only your API key.
What are tasks?
A task is one CAPTCHA you want solved. See how task type names say what is solved and returned, and pick the right task for your page and proxy setup.