Quick Start

Step. 1: Create Account

Before you are ready to use Pixelant's services, you need to go to the user panel and register your account. There are many ways to register. If you don't see the way you want to register, please contact us.

Step. 2: Get your API Key

Once you have registered, you can obtain your api key from the home page panel.

Step. 3: Create Task

When you have the key ready, you can create the task using our API method createTask. Here is an example of the parameters of a http request.

POST https://api.pixelant.ai/api/v1/createTask
Host: api.pixelant.ai
Content-Type: application/json
x-api-key: sk_0cqyZoycFci4eIQnQSgucyCTkZU...W31wLlefAt9IF2tn1YFV0

{
  "service": "ai.ocr.text",
  "input": {
    "module": "common",
    "body": "/9j/4AAQSkZJRgABA......"  // base64 encoded image
  }
}

When your account has sent a request with sufficient balance and correct parameters, you will receive the following api response.

{
  "errorId": 0,
  "errorCode": "",
  "errorDescription": "",
  // Make a note of this ID, which will be used in subsequent query results
  "taskId": "61138bb6-19fb-11ec-a9c8-0242ac110006"
}

Step. 4: Get Task Result

Usually Identify task returns the result directly via createTask But task token takes more time, so you need to go through getTaskResult separately. Obtain the task result.

GET https://api.pixelant.ai/api/v1/getTaskResult/[taskId]
Host: api.pixelant.ai
Content-Type: application/json
x-api-key: sk_0cqyZoycFci4eIQnQSgucyCTkZU...W31wLlefAt9IF2tn1YFV0

Generally just wait for '1-10s' and you will get the result of the task execution via getTaskResult. The following is a successful response When a request is sent with sufficient balance and correct parameters in your account, you will get the following api response

{
  "errorId": 0,
  "solution": {
    "token": "03AGdBq25SxXT-pmSeBXjzScW-EiocHwwpwqtk1QXlJnGnUJCZrgjwLLdt7cb0..."
  },
  "status": "ready"
}