Image Text Recognition API Documentation

Use the Image Text Recognition API for ecommerce automation. Review request parameters, response fields, and runnable examples.

Availability: Available

This endpoint is active in the v1 gateway, OpenAPI, and subscription catalog. A successful call consumes 1 billing unit.

POST /v1/tools/image-text

The request and response fields below match the current public contract.

Quick call

First create an API key, then store it in a server-side environment variable:

export ECOMMERCE_DATA_API_KEY="your_api_key"

curl --request POST \
  --url https://ecommercedataapi.com/v1/tools/image-text \
  --header "Content-Type: application/json" \
  --header "X-API-Key: ${ECOMMERCE_DATA_API_KEY}" \
  --data '{
  "type": 0,
  "fn": "LATIN",
  "url": "https://m.media-amazon.com/images/I/71NQ9P7yLIL.jpg"
}'

Integrate with an AI CLI

Copy for your AI CLI

Paste this task into Codex, Claude Code, Gemini CLI, or another coding agent.

Integrate the "Image Text Recognition" endpoint from Ecommerce Data API into the current repository. Make the changes directly instead of only returning sample code.

API documentation: https://ecommercedataapi.com/en/docs/tools/image-text
Endpoint: POST https://ecommercedataapi.com/v1/tools/image-text
API key environment variable: ECOMMERCE_DATA_API_KEY

Example request:
{
"type": 0,
"fn": "LATIN",
"url": "https://m.media-amazon.com/images/I/71NQ9P7yLIL.jpg"
}

Requirements:
1. Read the API documentation first, then inspect the repository's language, framework, HTTP client, directory structure, and environment-variable conventions.
2. Reuse the existing API client and error-handling patterns. If none exist, add the smallest reusable Ecommerce Data API client and an endpoint-specific wrapper.
3. Read the key from the server-side ECOMMERCE_DATA_API_KEY environment variable and send Content-Type: application/json plus the X-API-Key header. Never write a real key into source code, browser code, logs, test snapshots, or Git.
4. If the environment variable is missing, tell me to configure ECOMMERCE_DATA_API_KEY myself. Do not request, print, or invent the real key, and continue implementing code and tests that do not require a live request.
5. Implement request and response types from the documentation. Handle non-2xx responses, request_id, error.code, error.message, and 429 rate limits.
6. Add a minimal usage example or test that follows the repository's conventions. Run one minimal live request only when the key is already configured and external requests are allowed; otherwise use mocks or static validation.
7. Run the relevant formatter, type checker, and tests. Report changed files, usage, verification results, and any environment variable I still need to configure.

Need an API key?Create API key

Open this request in Postman

Download the preconfigured collection for this endpoint, then import it into Postman.

Download Postman config

Set the apiKey collection variable after import.Create API key

Node.js example

const response = await fetch(
  'https://ecommercedataapi.com/v1/tools/image-text',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.ECOMMERCE_DATA_API_KEY,
    },
    body: JSON.stringify({
      type: 0,
      fn: 'LATIN',
      url: 'https://m.media-amazon.com/images/I/71NQ9P7yLIL.jpg',
    }),
  }
);

const result = await response.json();

if (!response.ok) {
  throw new Error(`${result.error?.code}: ${result.error?.message}`);
}

console.log(result.data);

Python example

import os
import requests

response = requests.post(
    "https://ecommercedataapi.com/v1/tools/image-text",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": os.environ["ECOMMERCE_DATA_API_KEY"],
    },
    json={
        "type": 0,
        "fn": "LATIN",
        "url": "https://m.media-amazon.com/images/I/71NQ9P7yLIL.jpg",
    },
    timeout=30,
)

response.raise_for_status()
print(response.json()["data"])

Request body

Send the fields below directly in the JSON body without an extra wrapper. Undefined fields are rejected.

Use url for type=0, base64 for type=1, or an image file for type=2.

Field	Type	Required	Description	Example
`type`	Integer	Yes	Input source type.	2
`fn`	String	Yes	Recognition language.	CHINESE
`url`	String	No	Public image URL.	https://m.media-amazon.com/images/I/71NQ9P7yLIL.jpg
`base64`	String	No	Base64-encoded image content.	iVBORw0KGgoAAAANSUhEUg...
`image`	File	When `type=2`	Image file uploaded as multipart/form-data, up to 10 MB.	image.jpg

Response structure

Field	Type	Description
`request_id`	String	Unique identifier for this request.
`data`	String or scalar	Endpoint business data.

For this endpoint, data itself is the business value.

Response fields

Field	Type	Description	Example
`data`	String	Data.	Wireless Charger

Response example

{
  "request_id": "8fb43e59-4ff9-4dc8-a4b7-2ed164e45ab8",
  "data": "Wireless Charger"
}

See Errors and rate limits for error payloads, request tracing, and rate-limit headers.

Availability: Available

This endpoint is active in the v1 gateway, OpenAPI, and subscription catalog. A successful call consumes 1 billing unit.

POST /v1/tools/image-text

The request and response fields below match the current public contract.

Quick call

First create an API key, then store it in a server-side environment variable:

export ECOMMERCE_DATA_API_KEY="your_api_key"

curl --request POST \
  --url https://ecommercedataapi.com/v1/tools/image-text \
  --header "Content-Type: application/json" \
  --header "X-API-Key: ${ECOMMERCE_DATA_API_KEY}" \
  --data '{
  "type": 0,
  "fn": "LATIN",
  "url": "https://m.media-amazon.com/images/I/71NQ9P7yLIL.jpg"
}'

Integrate with an AI CLI

Copy for your AI CLI

Paste this task into Codex, Claude Code, Gemini CLI, or another coding agent.

Integrate the "Image Text Recognition" endpoint from Ecommerce Data API into the current repository. Make the changes directly instead of only returning sample code.

API documentation: https://ecommercedataapi.com/en/docs/tools/image-text
Endpoint: POST https://ecommercedataapi.com/v1/tools/image-text
API key environment variable: ECOMMERCE_DATA_API_KEY

Example request:
{
"type": 0,
"fn": "LATIN",
"url": "https://m.media-amazon.com/images/I/71NQ9P7yLIL.jpg"
}

Need an API key?Create API key

Open this request in Postman

Download the preconfigured collection for this endpoint, then import it into Postman.

Download Postman config

Set the apiKey collection variable after import.Create API key

Node.js example

const response = await fetch(
  'https://ecommercedataapi.com/v1/tools/image-text',
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'X-API-Key': process.env.ECOMMERCE_DATA_API_KEY,
    },
    body: JSON.stringify({
      type: 0,
      fn: 'LATIN',
      url: 'https://m.media-amazon.com/images/I/71NQ9P7yLIL.jpg',
    }),
  }
);

const result = await response.json();

if (!response.ok) {
  throw new Error(`${result.error?.code}: ${result.error?.message}`);
}

console.log(result.data);

Python example

import os
import requests

response = requests.post(
    "https://ecommercedataapi.com/v1/tools/image-text",
    headers={
        "Content-Type": "application/json",
        "X-API-Key": os.environ["ECOMMERCE_DATA_API_KEY"],
    },
    json={
        "type": 0,
        "fn": "LATIN",
        "url": "https://m.media-amazon.com/images/I/71NQ9P7yLIL.jpg",
    },
    timeout=30,
)

response.raise_for_status()
print(response.json()["data"])

Request body

Send the fields below directly in the JSON body without an extra wrapper. Undefined fields are rejected.

Use url for type=0, base64 for type=1, or an image file for type=2.

Field	Type	Required	Description	Example
`type`	Integer	Yes	Input source type.	2
`fn`	String	Yes	Recognition language.	CHINESE
`url`	String	No	Public image URL.	https://m.media-amazon.com/images/I/71NQ9P7yLIL.jpg
`base64`	String	No	Base64-encoded image content.	iVBORw0KGgoAAAANSUhEUg...
`image`	File	When `type=2`	Image file uploaded as multipart/form-data, up to 10 MB.	image.jpg

Response structure

Field	Type	Description
`request_id`	String	Unique identifier for this request.
`data`	String or scalar	Endpoint business data.

For this endpoint, data itself is the business value.

Response fields

Field	Type	Description	Example
`data`	String	Data.	Wireless Charger

Response example

{
  "request_id": "8fb43e59-4ff9-4dc8-a4b7-2ed164e45ab8",
  "data": "Wireless Charger"
}

See Errors and rate limits for error payloads, request tracing, and rate-limit headers.

Image Text Recognition

API data samples

Quick call

Integrate with an AI CLI

Copy for your AI CLI

Open this request in Postman

Node.js example

Python example

Request body

Response structure

Response fields

Response example

On this page

Image Text Recognition

API data samples

Quick call

Integrate with an AI CLI

Copy for your AI CLI

Open this request in Postman

Node.js example

Python example

Request body

Response structure

Response fields

Response example

On this page