Nex Captcha

PRODUCT TEST WORKSPACE

Capy Puzzle

Captcha verification product

CAPY_PUZZLE

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" : "CAPY_PUZZLE",
  "adapter" : {
    "websiteURL" : "https://example.com/register",
    "websiteKey" : "YOUR_WEBSITEKEY"
  }
}

03 / RESULT

Response example

EXAMPLE
Task ID — 
{
  "code" : 0,
  "msg" : "Success",
  "data" : {
    "taskId" : "11111111-1111-4111-8111-111111111111",
    "productCode" : "CAPY_PUZZLE",
    "state" : "SUCCEEDED",
    "solution" : {
      "captchakey" : "EXAMPLE_CAPTCHAKEY",
      "challengekey" : "EXAMPLE_CHALLENGEKEY",
      "answer" : "EXAMPLE_ANSWER",
      "respKey" : "EXAMPLE_RESPKEY"
    }
  }
}

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

Capy Puzzle · 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": "CAPY_PUZZLE", // Product code matching the adapter parameters.
  "adapter": { // Product-specific parameter object.
    "websiteURL": "https://example.com/register", // Full URL of the page containing the challenge.
    "websiteKey": "YOUR_WEBSITEKEY", // Public site key from the target page.
    "userAgent": "YOUR_BROWSER_USER_AGENT", // User-Agent of the browser that obtained the challenge.
    "proxyType": "http", // Proxy protocol, for example http.
    "proxyAddress": "YOUR_PROXY_HOST", // Proxy hostname or IP address.
    "proxyPort": 8080, // Proxy port.
    "proxyLogin": "YOUR_PROXYLOGIN", // Proxy username, when authentication is required.
    "proxyPassword": "YOUR_PROXYPASSWORD" // Proxy password, when authentication is required.
  }
}

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": "CAPY_PUZZLE", // 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.
      "captchakey": "EXAMPLE_CAPTCHAKEY", // Verification token to submit to the target website.
      "challengekey": "EXAMPLE_CHALLENGEKEY", // Product-specific answer field; use it according to the target website verification protocol.
      "answer": "EXAMPLE_ANSWER", // Recognized text or text answer.
      "respKey": "EXAMPLE_RESPKEY" // Verification token to submit to the target website.
    }
  }
}

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.websiteURLstringYesFull URL of the page containing the challenge.
adapter.websiteKeystringYesPublic site key from the target page.
adapter.userAgentstringNoUser-Agent of the browser that obtained the challenge.
adapter.proxyTypestringNoProxy protocol, for example http.
adapter.proxyAddressstringNoProxy hostname or IP address.
adapter.proxyPortintegerNoProxy port.
adapter.proxyLoginstringNoProxy username, when authentication is required.
adapter.proxyPasswordstringNoProxy password, when authentication is required.

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.captchakeystringVerification token to submit to the target website.
data.solution.challengekeystringProduct-specific answer field; use it according to the target website verification protocol.
data.solution.answerstringRecognized text or text answer.
data.solution.respKeystringVerification token to submit to the target website.

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