CaptchaSonic

Create Task

POST

/createTask

base

Request

Body Params application/json

apiKey

string

Apikey

required

API key to authenticate the request

Example:

your_api_key_here

source

Source

optional

Source of the data

Any of

string

null

Example:

Not required

version

Version

optional

Version of the API being used

Any of

string

null

Example:

Not required

appID

Appid

optional

Not required

Any of

integer

null

task

object

required

Task object containing the details of the task

type

string

Type

required

The type of task')

Example:

["PopularCaptchaImage","ReCaptchaV2Image","GeetestImage","AwsWafImage","OcrImage"]

queries

Queries

optional

List of queries related to the task. Max 50

examples

Examples

optional

Optional list of examples images for task | Max3

question

Question

optional

Question for that classification task

screenshort

Screenshort

optional

Whether to include a screenshot in the task

questionType

Questiontype

optional

objectClassify, objectClick, objectDrag, objectDraw, objectTag

websiteURL

Websiteurl

optional

URL of the website to scrape or reference

websiteKEY

Websitekey

optional

Key associated with the website for authentication

websiteKey

Websitekey

optional

Key associated with the website for authentication

module

Module

optional

OCR only | module ID

numeric

Numeric

optional

OCR only | Indicates if the task involves numerical values

case

Case

optional

OCR only | Indicates if the task should be case-sensitive

minLength

Minlength

optional

OCR only | The minimum length of the text (if applicable)

maxLength

Maxlength

optional

OCR only | The maximum length of the text (if applicable)

proxy

Proxy

optional

If user provides a proxy use that to solve.

Example

{
  "apiKey": "your_api_key_here",
  "source": "string",
  "version": "string",
  "appID": 0,
  "task": {
    "type": [
      "PopularCaptchaImage",
      "ReCaptchaV2Image",
      "GeetestImage",
      "AwsWafImage",
      "OcrImage"
    ],
    "queries": [
      null
    ],
    "examples": [
      null
    ],
    "question": "string",
    "screenshort": true,
    "questionType": "string",
    "websiteURL": "string",
    "websiteKEY": "string",
    "websiteKey": "string",
    "module": "string",
    "numeric": true,
    "case": true,
    "minLength": 0,
    "maxLength": 0,
    "proxy": "string"
  }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/createTask' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiKey": "your_api_key_here",
    "source": "string",
    "version": "string",
    "appID": 0,
    "task": {
        "type": [
            "PopularCaptchaImage",
            "ReCaptchaV2Image",
            "GeetestImage",
            "AwsWafImage",
            "OcrImage"
        ],
        "queries": [
            null
        ],
        "examples": [
            null
        ],
        "question": "string",
        "screenshort": true,
        "questionType": "string",
        "websiteURL": "string",
        "websiteKEY": "string",
        "websiteKey": "string",
        "module": "string",
        "numeric": true,
        "case": true,
        "minLength": 0,
        "maxLength": 0,
        "proxy": "string"
    }
}'

Responses

🟢200OK

application/json

Successful Response

Body

No schema defined

Example

null

🟠422Parameter Error

Modified at 2025-02-19 12:32:15

CaptchaSonic

Balance