Create a captcha recognition task, specifying in the parameters which type of captcha to recognize.
Request node: INTERNATIONAL NODE https://api.yescaptcha.com
DOMESTIC NODE https://cn.yescaptcha.com
Request address: https://api.yescaptcha.com/getBalance
Request format:POST
application/json
Request parameters
Parameters | Type | Required | Description |
---|---|---|---|
clientKey | string | true | The clientkey, which can be found in the personal center |
task | string | true | You may peruse all captcha types at this location for the available captcha categories. |
Request example:
ImageToTextTask Text-based captcha (ordinary variable-length alphanumeric captcha).
{ "clientKey":"cc9c18d3e263515c2c072b36a7125eecc078618f", "task": // Please specify the type of captcha that you wish to recognize. { "type":"ImageToTextTask", "body":"The BASE64 value of the image." } }
Response data
Parameters | Type | Description |
---|---|---|
errorId | Integer | Error message: 0 - No error, 1 - Error exists |
errorCode | string | Error code, click here to see the complete list of errors |
errorDescription | string | Error detailed description |
taskId | string | The ID of the created task can be used to retrieve the recognition results using the getTaskResult interface |
Response example
{ "errorId": 0, "errorCode": "", "errorDescription": "", "taskId": "2376919c-1863-11ec-a012-94e6f7355a0b" // Please record this ID for future use in the subsequent steps. }