Text Recognition API

API Description

The text recognition API supports returning text positions.

Request Description

URL

https://openapi.sys303.com/api/cognitive/ocr

Parameters

Header Parameters

Parameter	Value
Content-Type	multipart/form-data
X-Secret	Get it here

Body Parameters

Parameter	Required	Type	Possible Values	Description
file	Yes	stream	-	Image file, size must not exceed 10MB, shortest side at least 15px, longest side max 8192px.
lang	Yes	int	[0, 1, 2, 3]	Recognition language type, default is Tibetan [0: Tibetan, 1: Chinese, 2: English, 3: Chinese-Tibetan mixed]

Request Example

bash

curl --request POST \
  --url https://openapi.sys303.com/api/cognitive/ocr \
  --header 'Accept: */*' \
  --header 'X-Secret: {X-Secret}' \
  --header 'content-type: multipart/form-data' \
  --form lang=0 \
  --form 'file=@[object Object]'

python

# encoding:utf-8
import requests
url = "https://openapi.sys303.com/api/cognitive/ocr"
headers = {
    "Accept": "*/*",
    "X-Secret": "your X-Secret"
}

files = {
    "file": open("test.png", "rb")  # change to your image path
}
data = {
    "lang": "0"
}
response = requests.post(url, headers=headers, files=files, data=data)
print(response.status_code)
print(response.text)

C#

using System;
using System.IO;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        var url = "https://openapi.sys303.com/api/cognitive/ocr";
        var secret = "your X-Secret";
        var filePath = "test.png";

        using var httpClient = new HttpClient();

        using var form = new MultipartFormDataContent();

        // lang parameter
        form.Add(new StringContent("0"), "lang");

        // file parameter
        var fileBytes = File.ReadAllBytes(filePath);
        var fileContent = new ByteArrayContent(fileBytes);

        fileContent.Headers.ContentType = MediaTypeHeaderValue.Parse("application/octet-stream");

        form.Add(fileContent, "file", Path.GetFileName(filePath));

        // header
        httpClient.DefaultRequestHeaders.Add("X-Secret", secret);
        httpClient.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("*/*"));

        var response = await httpClient.PostAsync(url, form);

        var result = await response.Content.ReadAsStringAsync();

        Console.WriteLine($"Status: {response.StatusCode}");
        Console.WriteLine(result);
    }
}

Java

import okhttp3.*;
import java.io.File;
import java.io.IOException;

public class OcrDemo {

    public static void main(String[] args) throws IOException {

        String url = "https://openapi.sys303.com/api/cognitive/ocr";
        String secret = "your X-Secret";
        String filePath = "test.png";

        OkHttpClient client = new OkHttpClient();

        File file = new File(filePath);

        RequestBody fileBody = RequestBody.create(
                file,
                MediaType.parse("application/octet-stream")
        );

        MultipartBody requestBody = new MultipartBody.Builder()
                .setType(MultipartBody.FORM)
                .addFormDataPart("lang", "0")
                .addFormDataPart(
                        "file",
                        file.getName(),
                        fileBody
                )
                .build();

        Request request = new Request.Builder()
                .url(url)
                .addHeader("Accept", "*/*")
                .addHeader("X-Secret", secret)
                .post(requestBody)
                .build();

        try (Response response = client.newCall(request).execute()) {
            System.out.println("Status: " + response.code());
            System.out.println(response.body().string());
        }
    }
}

Return Explanation

Parameter Description

Field	Required	Type	Status	Description
traceId	Yes	String	-	Unique traceId for troubleshooting
msgId	Yes	String	-	Business status code
msg	Yes	String		Error description
data	Yes	dict	-	Recognition result array
+ lines	No	string	-	Recognition result string
++ text	No	string	-	Text of the current line
++ left	No	int	-	Left position of the text line
++ top	No	int	-	Top position of the text line
++ width	No	int	-	Width of the text line
++ height	No	int	-	Height of the text line

Return Example

Success

{
    "traceId": "0HNL06O44AU0U:00000001",
    "msgId": "2000000",
    "msg": "success",
    "data": {
        "lines": [
            {
                "text": "Recognized text 1",
                "left": 105,
                "top": 45,
                "width": 355,
                "height": 74
            },
            {
                "text": "Recognized text 2",
                "left": 241,
                "top": 513,
                "width": 81,
                "height": 38
            }
        ]
    }
}

Failure

Auth Failed:

{
  "traceId": "0HNLN3J9DCJSE:00000001",
  "msgId": "4011001",
  "msg": "AuthFailed",
  "data": null
}

Invalid request parameters:

{
    "traceId": "0HNL06O44AU14:00000001",
    "msgId": "500",
    "msg": "Specified argument was out of the range of valid values. (Parameter 'langType')",
    "data": null
}

Insufficient quota:

{
    "traceId": "0HNL06O44AU1F:00000001",
    "msgId": "2001001",
    "msg": "InsufficientInventory",
    "data": null
}