Skip to main content
POST
general information extration

Authorizations

x-ti-app-id
string
header
required

Please Sign in to TextIn and navigate to "Console - API Keys" to view x-ti-app-id

x-ti-secret-code
string
header
required

Please Sign in to TextIn and navigate to "Console - API Keys" to view x-ti-secret-code

Body

application/json

Supported file formats: png, jpg, jpeg, pdf, bmp, tiff, webp, doc, docx, html, mhtml, xls, xlsx, csv, ppt, pptx, txt, ofd.

Supports schema-based structured information extraction, where you define the field structure for precise extraction.

file
object
required

File information

schema
object
required

Extraction data structure. See the Schema Guide.

Example:
parse_options
object

Parsing stage parameters

extract_options
object

Advanced extraction controls

Response

200 - application/json

Response result

code
enum<integer>
required

Status code

  • 200: Success
  • 40101: x-ti-app-id or x-ti-secret-code is empty
  • 40102: x-ti-app-id or x-ti-secret-code is invalid, authentication failed
  • 40103: Client IP is not in the allowlist
  • 40003: Insufficient balance, please recharge before using
  • 40004: Parameter error, please check the technical documentation and verify the parameters
  • 40007: Robot does not exist or is not published
  • 40008: Robot is not activated, please activate it from the market before retrying
  • 40302: Uploaded file size does not meet requirements, file size must not exceed 50M
  • 40303: File type not supported. The API will return the actual detected file type, e.g., "Current file type is .gif"
  • 40304: Image dimensions do not meet requirements. Images with aspect ratio less than 2 must have width and height between 20-20000 pixels, other images must have width and height between 20-10000 pixels
  • 40305: Recognition file not uploaded
  • 40306: QPS exceeds limit
  • 40400: Invalid request URL, please check if the URL is correct
  • 40422: The file is corrupted
  • 40423: Password required or incorrect password
  • 40424: Page number out of range
  • 40425: The input file format is not supported
  • 40428: Process office file failed or timeout
  • 500: Internal server error
  • 50011: LLM Connection Failed (timeout connecting to the large model)
  • 50012: LLM Engine Failed (large model engine error)
  • 50207: Partial failed
Available options:
200,
40101,
40102,
40103,
40003,
40004,
40007,
40008,
40302,
40303,
40304,
40305,
40306,
40400,
40422,
40423,
40424,
40425,
40428,
500,
50011,
50012,
50207
Example:

200

message
string
required

Status message

Example:

"Success"

version
string
required

Version number

Example:

"v3.0.29_20250819"

duration
integer

Total processing time (milliseconds)

Example:

8267

x_request_id
string

Request ID

Example:

"7596b8c9d2ddbc9924b66651e9efc174"

status
string

Processing status

Example:

"finished"

result
object
part_durations
object

Processing time per stage