---
title: "Perform text detection and bounding on an image."
method: POST
path: "/api/ai/images/v2/image-text-detection"
---

# Perform text detection and bounding on an image.

`POST /api/ai/images/v2/image-text-detection`

## Request

- Base URL: `https://api.worqhat.com`
- URL: `https://api.worqhat.com/api/ai/images/v2/image-text-detection`
- Auth: API key in header `x-api-key` and API key in header `x-org-key`
- TypeScript: <https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints/docs/api/ai/images/v2/image-text-detection/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body `multipart/form-data`

- object
  - `image` string, binary

## Response `200`

Success

- object
  - `id` string: The ID of the response
  - `status` string: The status of the response
  - `timestamp` integer: The timestamp of the response
  - `content` ImageDetectedText[]: The detected text content
    - `confidence` number: The confidence level of the detected text
    - `detected_text` string: The detected text
    - `geometry` ImageTextGeometry
      - `bounding_box` ImageTextBoundingBox
        - `height` number: The height of the bounding box
        - `left` number: The left coordinate of the bounding box
        - `top` number: The top coordinate of the bounding box
        - `width` number: The width of the bounding box
      - `polygon` ImageTextPoint[]: The polygon coordinates of the geometry
        - `x` number: The X coordinate of the point
        - `y` number: The Y coordinate of the point
    - `id` integer: The ID of the detected text
    - `parent_id` integer: The ID of the parent text (if applicable)
    - `type` string: The type of the detected text
  - `processing_count` integer: The number of images processed

## Other responses

- `400`: Bad Request
- `401`: Unauthorized - Invalid API Key or Organization Key
- `404`: Not Found
- `406`: Not Acceptable - Invalid Content Type or Content not supported
- `500`: Internal Server Error

## Changes

- **2023-06-27** `ecd19b0ebd32`: 6 warning, 6 info
  - removed the optional property `content/items/Confidence` from the response with the `200` status
  - removed the optional property `content/items/DetectedText` from the response with the `200` status
  - removed the optional property `content/items/Geometry` from the response with the `200` status
  - removed the optional property `content/items/Id` from the response with the `200` status
  - …8 more
- **2023-06-26** `f33ef3b79a22`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints/changes/api/ai/images/v2/image-text-detection/post.md)

---

[API](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints.md) - [All operations](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints/llms.txt) - [OpenAPI document](https://skmtc.dev/worqhat/apis/worqhat-ai-api-endpoints/revisions/a1044e79bd85?raw)