POST
/
api
/
ai
/
images
/
v2
/
image-text-detection
Authorization
Body
curl --request POST \
  --url https://api.worqhat.com/api/ai/images/v2/image-text-detection \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: multi-part/form-data' \
  --data '{
  "image": "/path/to/image.jpg",
  "output_type": "json"
}'
{
  "code": 200,
  "data": "WorqHat Introduction to WorqHat AI Custom Models Studio",
  "processing_count": 1,
  "processing_id": "7a07501f-a611-4c19-b5f9-b62e429c54f8",
  "processing_time": 4554,
  "status": "success"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multi-part/form-data
image
string

The image to be sent as input.

output_type
enum<string>

The type of output to be generated. You can choose between json and text. json will return the text detection results as a JSON object with the scan words marked and positional information. text will return the text detection results as a plain text string.

Available options:
json,
text

Response

200 - application/json
code
integer

The HTTP status code.

data
string

The response data.

processing_count
integer

The number of times the request has been processed. This is what is considered in the Billing Process. This is either the number of times the image is processed or the number of words that the server processes.

processing_id
string

A universally unique identifier for the request. This can be used to track the request in the logs.

processing_time
integer

The time taken to process the request, in milliseconds.

status
string

Status indicating the success of the response. In case you have an error for multipart/form-data requests, try removing the Content-Type header.

Was this page helpful?

Web Extraction APISpeech Extraction