Home›API

Error codes

Any error response contains errorId: 1, errorCode and a text description errorDescription. The HTTP status is always 200.

json

{
  "errorId": 1,
  "errorCode": "ERROR_ZERO_BALANCE",
  "errorDescription": "Account has zero or negative balance."
}

If an error keeps recurring and you cannot fix it yourself, contact support (the Help button in the bot) and include the taskId, the time of the request and the request body without the key.

#Summary table

code	where it occurs	money	retry
`ERROR_KEY_DOES_NOT_EXIST`	any method	not charged	no, fix the key
`ERROR_KEY_DISABLED`	`createTask`	not charged	no, contact support
`ERROR_ZERO_BALANCE`	`createTask`	not charged	after topping up
`ERROR_NO_SLOT_AVAILABLE`	`createTask`	not charged	yes, once some tasks have finished
`ERROR_TASK_NOT_SUPPORTED`	`createTask`	not charged	no, fix `type`
`ERROR_BAD_PARAMETERS`	`createTask`	not charged	no, add the missing parameters
`ERROR_SITE_NOT_SUPPORTED`	`createTask`	not charged	no
`ERROR_NO_SUCH_CAPCHA_ID`	`getTaskResult`	not charged	no
`ERROR_CAPTCHA_UNSOLVABLE`	`getTaskResult`	refunded	yes, with a new `gid`
`ERROR_SERVICE_UNAVAILABLE`	`createTask`	refunded	yes, after 5–30 seconds

#ERROR_KEY_DOES_NOT_EXIST

When it occurs. The clientKey was not found, is incorrect or was not provided. A request whose body is not valid JSON returns the same error.

What to do. Get your key in the bot (My key) and make sure you copied it in full, without spaces.

json

{
  "errorId": 1,
  "errorCode": "ERROR_KEY_DOES_NOT_EXIST",
  "errorDescription": "Account authorization key not found in the system."
}

#ERROR_KEY_DISABLED

When it occurs. The key was disabled by an administrator, for example for a rule violation. The error is returned when creating a task; getBalance keeps responding.

What to do. Contact support.

json

{
  "errorId": 1,
  "errorCode": "ERROR_KEY_DISABLED",
  "errorDescription": "Account is disabled."
}

#ERROR_ZERO_BALANCE

When it occurs. The balance is lower than the cost of one task. Keep in mind that the cost of tasks in progress has already been deducted from the balance.

What to do. Top up your balance in the bot. getBalance shows the current value.

json

{
  "errorId": 1,
  "errorCode": "ERROR_ZERO_BALANCE",
  "errorDescription": "Account has zero or negative balance."
}

#ERROR_NO_SLOT_AVAILABLE

When it occurs. The key already has 600 tasks in progress, which is the limit of concurrent tasks.

What to do. Wait for some tasks to finish and try again. Do not create tasks faster than you receive results.

json

{
  "errorId": 1,
  "errorCode": "ERROR_NO_SLOT_AVAILABLE",
  "errorDescription": "Too many parallel tasks, try again later."
}

#ERROR_TASK_NOT_SUPPORTED

When it occurs. task.type specifies an unsupported type, or task was not provided or is not an object.

What to do. Use HCaptchaTask or HCaptchaTaskProxyless and pass task as an object.

json

{
  "errorId": 1,
  "errorCode": "ERROR_TASK_NOT_SUPPORTED",
  "errorDescription": "Task type is not supported."
}

#ERROR_BAD_PARAMETERS

When it occurs. The task is missing websiteURL or websiteKey.

What to do. Pass both fields. Give the full address, including https://.

json

{
  "errorId": 1,
  "errorCode": "ERROR_BAD_PARAMETERS",
  "errorDescription": "Required parameters are missing or invalid."
}

#ERROR_SITE_NOT_SUPPORTED

When it occurs. The host in websiteURL is not on the list of allowed hosts: store.steampowered.com, steamcommunity.com, help.steampowered.com.

What to do. Check the page address. Other sites are not supported.

json

{
  "errorId": 1,
  "errorCode": "ERROR_SITE_NOT_SUPPORTED",
  "errorDescription": "This website is not supported."
}

#ERROR_NO_SUCH_CAPCHA_ID

When it occurs. There is no task with this taskId among your key's tasks: the identifier is wrong, belongs to someone else, is not a number, or the task has already been deleted (tasks are kept for 5 minutes).

What to do. Use the taskId from the createTask response and request the result within 5 minutes.

json

{
  "errorId": 1,
  "errorCode": "ERROR_NO_SUCH_CAPCHA_ID",
  "errorDescription": "Task not found."
}

#ERROR_CAPTCHA_UNSOLVABLE

When it occurs. The captcha could not be solved: the parameters are outdated or wrong (most often a used or expired gid), a temporary failure occurred, or the result was not ready within 5 minutes. The cost of the task is refunded.

What to do. Get a new gid and create a new task. If the error keeps coming back with correct parameters, contact support.

json

{
  "errorId": 1,
  "errorCode": "ERROR_CAPTCHA_UNSOLVABLE",
  "errorDescription": "The captcha could not be solved. This is usually a temporary condition, try again."
}

#ERROR_SERVICE_UNAVAILABLE

When it occurs. The task could not be submitted for solving because of a temporary failure. The cost is refunded and no task is created.

What to do. Repeat createTask after 5–30 seconds with the same parameters.

json

{
  "errorId": 1,
  "errorCode": "ERROR_SERVICE_UNAVAILABLE",
  "errorDescription": "Service is temporarily unavailable, try again later."
}