Documentation menu

Create Task

Description

This method creates a task for solving selected captcha type. In the parameters you need to pass the client authorization data, typed task data and other optional parameters.

Method address: https://capkill.com/api/createTask

Request format: JSON POST


Request parameters

Parameter Type Required Purpose
clientKey String Yes Client API key. You can get it here.
task Task type object Yes Task data. See list of available object descriptions here.
callbackUrl String No Optional web address where we will send result of captcha task processing. Contents are sent by POST request and are same to the contents of getTaskResult method. The content of the response is not checked and you must accept the request in 2 seconds then the connection will be closed.

Request examples:

Solving the usual captcha with the image

JSON with no errors
{
    "clientKey":"67b6bcbb1a728ea8d563de6d169a2057",
    "task":
        {
            "type":"ImageToTextTask",
            "body":"BASE64_BODY_HERE!"
        }
}

Solving ReCaptcha2

JSON with no errors
{
    "clientKey":"67b6bcbb1a728ea8d563de6d169a2057",
    "task":
        {
            "type":"NoCaptchaTaskProxyless",
            "websiteURL":"https://www.google.com/recaptcha/api2/demo",
            "websiteKey":"6Le-wvkSAAAAAPBMRTvw0Q4Muexq9bi0DJwx_mJ-"
        }
}

Response structure

Parameter Type Purpose
errorId Integer Error identificator.
0 - no errors, the task has been successfully created, task ID located in taskId property
1 - error, information about it is in the errorCode property
errorCode String Error code. Check out errors list.
taskId Integer Task ID for future use in getTaskResult method.

Response with task id

JSON with no errors
{
    "errorId":0,
    "taskId":53456
}

Response with error

JSON with no errors
{
    "errorId": 1,
    "errorCode": "ERROR_KEY_DOES_NOT_EXIST",
    "errorDescription": "Account authorization key not found in the system or has incorrect format",
    "taskId": 0
}