Image Extraction AI
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
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
The image to be sent as input.
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.
json
, text
Response
The HTTP status code.
The response data.
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.
A universally unique identifier for the request. This can be used to track the request in the logs.
The time taken to process the request, in milliseconds.
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?
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"
}