---
title: "Image Text Recognition"
method: POST
path: "/v1/tools/image-text"
tags: ["Tools"]
---

# Image Text Recognition

`POST /v1/tools/image-text`

## Request

- Base URL: `https://ecommercedataapi.com`
- URL: `https://ecommercedataapi.com/v1/tools/image-text`
- Auth: one of:
  - API key in header `X-API-Key`
  - HTTP bearer

Recognize Chinese or Latin text from an image URL, base64 input, or uploaded file.

## Request body

- ToolsImageTextRequest
  - `type` 0 | 1 | 2, required: Input source type.
  - `fn` 'CHINESE' | 'LATIN', required: Recognition language.
  - `url` string: Public image URL.
  - `base64` string: Base64-encoded image content.

## Response `200`

Image Text Recognition response.

- GatewaySuccess
  - `request_id` string, uuid, required
  - `data` unknown, required

## Other responses

- `400`: The request body or parameters are invalid.
- `401`: Authentication failed.
- `402`: The account does not have enough Credits for this request.
- `403`: The subscription does not include this endpoint.
- `404`: The endpoint does not exist.
- `413`: The request body is too large.
- `429`: The request limit was exceeded.
- `500`: An internal error occurred.
- `502`: The data service returned an invalid response.
- `503`: The data service is temporarily unavailable.
- `504`: The data service timed out.

---

[API](https://skmtc.dev/ecommercedataapi/apis/ecommerce-data-api.md) · [All operations](https://skmtc.dev/ecommercedataapi/apis/ecommerce-data-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ecommercedataapi/apis/ecommerce-data-api/revisions/bdae32c46b9e?raw)
