Tasks

Get the result of a task

Polls the result of a previously created task. While solving, status is processing (no solution). When done, status is ready and solution contains the answer whose shape depends on the captcha type (see Solution).

Limit: up to 120 requests per task; exceeding it may temporarily lock the account. Poll at a sane interval (e.g. every 1–3 seconds).

post/getTaskResult

Request body

clientKeystring required

Your account API key (from https://dash.capmonster.cloud). Authenticates the request.

taskIdinteger required

Task id obtained from createTask.

Example request

{
  "clientKey": "API_KEY",
  "taskId": 7654321
}

Response

Current task state (processing / ready), or a business error in the body (errorId: 1). Invalid key uses 403 and unknown task id uses 404 (below).

errorIdinteger

0 = success, non-zero = error.

errorCode'ERROR_KEY_DOES_NOT_EXIST' | 'ERROR_ZERO_BALANCE' | 'ERROR_TOO_BIG_CAPTCHA_FILESIZE' | 'ERROR_ZERO_CAPTCHA_FILESIZE' | 'ERROR_NO_SUCH_CAPCHA_ID' | 'WRONG_CAPTCHA_ID' | 'ERROR_CAPTCHA_UNSOLVABLE' | 'CAPTCHA_NOT_READY' | 'ERROR_IP_NOT_ALLOWED' | 'ERROR_IP_BANNED' | 'ERROR_NO_SUCH_METHOD' | 'ERROR_TOO_MUCH_REQUESTS' | 'ERROR_DOMAIN_NOT_ALLOWED' | 'ERROR_TOKEN_EXPIRED' | 'ERROR_NO_SLOT_AVAILABLE' | 'ERROR_RECAPTCHA_INVALID_SITEKEY' | 'ERROR_RECAPTCHA_INVALID_DOMAIN' | 'ERROR_RECAPTCHA_TIMEOUT' | 'ERROR_IP_BLOCKED' | 'ERROR_PROXY_CONNECT_REFUSED' | 'ERROR_PROXY_BANNED' | 'ERROR_PROXY_MISSING' | 'ERROR_PROXY_NOT_AUTHORISED' | 'ERROR_PROXY_READ_TIMEOUT' | 'ERROR_TASK_NOT_SUPPORTED' | 'ERROR_TASK_ABSENT' | 'ERROR_WRONG_USERAGENT'

Machine-readable error code returned when errorId is non-zero.

errorDescriptionstring nullable
status'processing' | 'ready'

processing — still being solved (no solution yet). ready — solved, solution is present.

coststring nullable

Cost charged for the task (string-encoded decimal), when available.

Example response

{
  "cost": "0.001"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.