Open API Interface Development Guide

All interface requests must include the following authentication parameters in the URL:

Request URL: /Code.ashx?op=code&app=api&token=YOUR_TOKEN&type=0

Call method: POST

The parameters are uniformly spelled in the URL, and the image data is passed through the POST body (multipart is supported file flow, form field, or plain text).

2.1 Enter the image to be recognized (choose one of three)

2.2 Core mode and engine control

2.3 Formatting and Layout Rules (Optional)

The following parameters pass values 1 Turn on the corresponding processing, value 0 Not on.
If there is no specific need, it is recommended not to pass it on, and leave it to the system to decide:

2.4 Return Value Description (JSON)

The recognition interface returns a standard JSON format. The value is null field is automatically omitted.

top-level fields

result Sub-object – Text result

result Sub-object - coordinate positioning data 🗺️

The following fields contain the precise position of each text block on the original image, suitable for scenarios such as highlighting overlays, area extraction, etc.

verticalText TextCellInfo object structure

[
  {
    "words": "The text content that is recognized",
    "trans": "Translation results (if any)",
    "pageIndex": 0,
    "location": {
      "left": 120.0,
      "top": 45.0,
      "width": 230.0,
      "height": 28.0
    }
  },
  ...
]

result Sub-object - File download

files The DownLoadInfo object structure in the DownLoadInfo object structure

state State enumeration

Back example

✅ Successful response (with coordinate data):

{
  "ocrType": 0,
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "processId": 3,
  "processName": "OCR-Node-01",
  "state": 2,
  "result": {
    "autoText": "Complete text after smart merge",
    "spiltText": "Original text divided by paragraphs",
    "verticalText": "[{\"words\":\"Hello\",\"location\":{\"left\":10,\"top\":20,\"width\":80,\"height\":22}}]",
    "resultType": 0,
    "lang": "chi_sim"
  }
}

❌ Error/Limit Response:

{
  "ocrType": 0,
  "processName": "Tips",
  "result": {
    "spiltText": "Today's API quota has been exhausted, please recharge and continue to use it！",
    "autoText": "Today's API quota has been exhausted, please recharge and continue to use it！"
  },
  "id": 1
}

Request URL: /Code.ashx?op=idcode&app=api&token=YOUR_TOKEN

Call method: POST

Function: Returned according to the recognition interface id Query the results of asynchronous processing. When the recognition interface returns state=0(pending), you can use this interface to poll to get the final result.

Back example

✅ Successful Response:

[
  {
    "ocrType": 0,
    "id": "a1b2c3d4-...",
    "processName": "OCR-Node-01",
    "state": 2,
    "result": {
      "autoText": "Identify the resulting text",
      "spiltText": "Segmented text",
      "resultType": 0
    }
  }
]

❌ Failed response (ID does not exist or result has expired):

no

Returns plain text no Indicates that no result was found for that ID, which may be an ID The error or result has expired and is cleared.

Request URL: /Code.ashx?op=imgUpload&app=api&token=YOUR_TOKEN

Call method: POST (multipart/form-data)

Function: Upload an image to the free image bed and return a direct link URL that is accessible on the public network. It is suitable for scenarios where you need to upload an image first and then use the URL to call the recognition interface.

Back example

✅ Successful Response:

https://cdn.example.com/uploads/abc123.jpg

❌ Failed response (file not uploaded or upload exception):

no

Returns plain text no Indicates that the file was not received or an exception occurred during the upload process.

Request URL: /Code.aspx?op=count&app=api&token=YOUR_TOKEN

Call method: GET

Through this interface, you can view the number of times the token has been used today and the remaining quota.

Back example

✅ Successful Response:

{
  "Account": "api",
  "TodayCount": 52, // Used today"LimitCount": 9948       // The total number of current remains
}

❌ Failure response (invalid or untransmitted token):

{
  "Account": "api",
  "TodayCount": 0,
  "LimitCount": 0
}

Note: If the token is invalid, no error will be reported, but will return JSON with all values of 0, depending on whether the LimitCount is yes or not 0 to judge the validity of the token.