createTask : captcha task creating
Create a captcha recognition task, specifying in the parameters which type of captcha to recognize.
Request node: INTERNATIONAL NODE https://api.yescaptcha.com
CHINA NODE https://cn.yescaptcha.com
Method address:: https://api.yescaptcha.com/createTask
Request format:POST
application/json
Request parameters
Parameters | Type | Required | Purpose |
---|---|---|---|
clientKey | string | Yes | Client API key. You can get it here. |
task | string | Yes | Task type. See list of available captcha categories here. |
Request example:
ImageToTextTask
{
"clientKey":"cc9c18d3e263515c2c072b36a7125eecc078618f",
"task": // Please specify the type of captcha that you wish to recognize.
{
"type":"ImageToTextTask",
"body":"The BASE64 value of the image."
}
}
Response structure
Parameter | Type | Purpose |
---|---|---|
errorId | Integer | Error identificator: 0 - No error, 1 - Error |
errorCode | string | Error code.Check out errors list. |
errorDescription | string | Error description |
taskId | string | Task ID for future use in getTaskResult method. |
Response example
{
"errorId": 0,
"errorCode": "",
"errorDescription": "",
"taskId": "2376919c-1863-11ec-a012-94e6f7355a0b" // Please record this ID for future use in the subsequent steps.
}