ai.visionengine.image

Create the task with the createTask interface to use Vision Engine for image recognition

WARNING

Create the task with the createTask.

This interface does not need to obtain the results separately, will directly return the image recognition results!

The task type field is as follows

ai.visionengine.image

Create Task

Create the task with the createTask.

Task Object Structure

Note that this type of task returns the task execution result directly after createTask, rather than getting it asynchronously through getTaskResult.

Properties	Type	Required	Description
service	String	Required	ai.visionengine.image
module	String	Required	All supported models are shown in the table below
websiteURL	String	Optional	Page source url to improve accuracy
image	String	Required	base64 encoded content of the image (no newlines, no data:image/***;charset=utf-8;base64,)
imageBackground	String	Required	base64 encoded content of the background image (no newlines, no data:image/***;charset=utf-8;base64,)
question	String	Optional	space_detection requires

SUPPORT IMG TYPES

module	Captcha Example	image	imageBackground
slider_1
rotate_1
rotate_2
shein

Example Request

// Example request using slider module
POST https://api.pixelant.ai/createTask
Host: api.pixelant.ai
Content-Type: application/json
x-api-key: sk_0cqyZoycFci4eIQnQSgucyCTkZU...W31wLlefAt9IF2tn1YFV0

Payload:
{
  "service": "ai.visionengine.image",
  "input": {
    "module": "slider_1",
    "image": "/9j/4AAQSkZJRgABA......",
    "imageBackground": "/9j/4AAQSkZJRgABA......",
    "websiteURL": "https://xxxx.com"
  }
}


// Example Response using slider module
{
  "errorId": 0,
  "errorCode": "",
  "errorDescription": "",
  "status": "ready",
  "solution": {
     "distance": 213,
  },
  "taskId": "..."
}

// Example request using rotate module
POST https://api.pixelant.ai/createTask
Host: api.pixelant.ai
Content-Type: application/json
x-api-key: sk_0cqyZoycFci4eIQnQSgucyCTkZU...W31wLlefAt9IF2tn1YFV0

Payload:
{
  "service": "ai.visionengine.image",
  "input": {
    "module": "rotate_1",
    "image": "/9j/4AAQSkZJRgABA......",
    "imageBackground": "/9j/4AAQSkZJRgABA......",
    "websiteURL": "https://xxxx.com"
  }
}


// Example Response using rotate_1 module
{
  "errorId": 0,
  "errorCode": "",
  "errorDescription": "",
  "status": "ready",
  "solution": {
     "angle": 154,
  },
  "taskId": "..."
}

// Example request using rotate module
POST https://api.pixelant.ai/createTask
Host: api.pixelant.ai
Content-Type: application/json
x-api-key: sk_0cqyZoycFci4eIQnQSgucyCTkZU...W31wLlefAt9IF2tn1YFV0

Payload:
{
  "service": "ai.visionengine.image",
  "input": {
    "module": "rotate_2",
    "image": "/9j/4AAQSkZJRgABA......",
    "websiteURL": "https://xxxx.com"
  }
}


// Example Response using rotate_2 module
{
  "errorId": 0,
  "errorCode": "",
  "errorDescription": "",
  "status": "ready",
  "solution": {
     "angle": 168,
  },
  "taskId": "..."
}

// Example request using rotate module
POST https://api.pixelant.ai/createTask
Host: api.pixelant.ai
Content-Type: application/json
x-api-key: sk_0cqyZoycFci4eIQnQSgucyCTkZU...W31wLlefAt9IF2tn1YFV0

Payload:
{
  "service": "ai.visionengine.image",
  "input": {
    "module": "shein",
    "image": "/9j/4AAQSkZJRgABA......",
    "question": "Please select the following graphics in order",
    "websiteURL": "https://xxxx.com"
  }
}


// Example Response using rotate module
{
  "errorId": 0,
  "errorCode": "",
  "errorDescription": "",
  "status": "ready",
  "solution": {
    "rects": [
      {
        "x1": 4,
        "y1": 126,
        "x2": 64,
        "y2": 184
      },
      {
        "x1": 140,
        "y1": 166,
        "x2": 190,
        "y2": 217
      },
      {
        "x1": 30,
        "y1": 16,
        "x2": 87,
        "y2": 70
      }
    ]
  },
  "taskId": "..."
}

ai.visionengine.image

Create Task

SUPPORT IMG TYPES

Example Request

On this page