Nex Captcha

PRODUCT TEST WORKSPACE

Bounding Box Captcha

Captcha verification product

BOUNDING_BOX

01 / CREATE

Create task

The editor starts with required fields and one conditional branch. Optional fields are listed below and can be loaded into the editor.

02 / REQUEST

Request preview

POST /api/validator/create.cgi
{
  "productCode" : "BOUNDING_BOX",
  "adapter" : {
    "body" : "BASE64_CONTENT"
  }
}

03 / RESULT

Response example

EXAMPLE
Task ID — 
{
  "code" : 0,
  "msg" : "Success",
  "data" : {
    "taskId" : "11111111-1111-4111-8111-111111111111",
    "productCode" : "BOUNDING_BOX",
    "state" : "SUCCEEDED",
    "solution" : {
      "bounding_boxes" : [ {
        "xMin" : 310,
        "xMax" : 385,
        "yMin" : 231,
        "yMax" : 308
      } ]
    }
  }
}

Illustrative response; not a live task result. Replace all request placeholders before submitting.

Read data.solution after state becomes SUCCEEDED. The solution fields depend on the product; other states may return an empty object.

04 / API REFERENCE

Bounding Box Captcha · API

For task creation and queries, send the API key in the apiKey HTTP header. JSON request bodies contain business parameters only.

Content-Type: application/json
apiKey: YOUR_API_KEY

Request example

POST /api/validator/create.cgi · JSONC
{
  "productCode": "BOUNDING_BOX", // Product code matching the adapter parameters.
  "adapter": { // Product-specific parameter object.
    "body": "BASE64_CONTENT", // Base64-encoded image or audio content.
    "comment": "YOUR_COMMENT" // Question or instructions for solving the challenge.
  }
}

Request headers: apiKey: YOUR_API_KEY

Comments explain the fields. Copy produces valid JSON without comments.

Response example

POST /api/validator/query.cgi · JSONC
{
  "code": 0, // Business result code: 0 means success; other values indicate an error.
  "msg": "Success", // Result message; may be empty on success.
  "data": { // Response data; may be null on an error.
    "taskId": "11111111-1111-4111-8111-111111111111", // Task ID returned by task creation.
    "productCode": "BOUNDING_BOX", // Product code matching the adapter parameters.
    "state": "SUCCEEDED", // Task state: CREATED, SUBMITTING, PROCESSING, SUCCEEDED, FAILED or EXPIRED.
    "solution": { // Product answer when SUCCEEDED; empty while processing or on failure.
      "bounding_boxes": [ // Bounding boxes of target objects.
        { // Product-specific answer field; use it according to the target website verification protocol.
          "xMin": 310, // Horizontal coordinate in pixels.
          "xMax": 385, // Horizontal coordinate in pixels.
          "yMin": 231, // Vertical coordinate in pixels.
          "yMax": 308 // Vertical coordinate in pixels.
        }
      ]
    }
  }
}

Creating a task returns its ID and initial state. Query the result or use WebSocket to receive the completed answer shown below.

Request parameters

FieldTypeRequiredDescription
productCodestringYesProduct code matching the adapter parameters.
adapterobjectYesProduct-specific parameter object.
adapter.bodystringYesBase64-encoded image or audio content.
adapter.commentstringNoQuestion or instructions for solving the challenge.

Response parameters

FieldTypeDescription
codeintegerBusiness result code: 0 means success; other values indicate an error.
msgstringResult message; may be empty on success.
dataobject | nullResponse data; may be null on an error.
data.taskIdstringTask ID returned by task creation.
data.productCodestringProduct code matching the adapter parameters.
data.statestringTask state: CREATED, SUBMITTING, PROCESSING, SUCCEEDED, FAILED or EXPIRED.
data.solutionobjectProduct answer when SUCCEEDED; empty while processing or on failure.
data.failureobject | omittedPublic diagnosis for FAILED/EXPIRED only; no raw provider messages. Follow the failure handling guide.
data.failure.codestringFailure code
data.failure.nextActionstringNext action
data.solution.bounding_boxesarrayBounding boxes of target objects.
data.solution.bounding_boxes[]objectProduct-specific answer field; use it according to the target website verification protocol.
data.solution.bounding_boxes[].xMinintegerHorizontal coordinate in pixels.
data.solution.bounding_boxes[].xMaxintegerHorizontal coordinate in pixels.
data.solution.bounding_boxes[].yMinintegerVertical coordinate in pixels.
data.solution.bounding_boxes[].yMaxintegerVertical coordinate in pixels.

Responses

HTTP business responses contain code, msg and data; code 0 means success. WebSocket uses a separate message structure.

-1317
Invalid API key.
-1100 / -1101
Invalid or missing request parameters.
-1401
Insufficient balance. Add funds before creating a task.
-1400 / -1001
System or task creation error.
API documentation