POST
/
api
/
v1
/
client
/
img2txt
Image to Text (OCR)
curl --request POST \
  --url http://localhost:8000/api/v1/client/img2txt \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form image='@example-file' \
  --form model=Nanonets_Ocr_S_F16 \
  --form 'language=<string>' \
  --form format=text \
  --form return_result_in_response=true \
  --form 'webhook_url=<string>'
{
  "data": {
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Authorizations

Authorization
string
header
required

API key obtained from the ModelBeam dashboard

Body

multipart/form-data
image
file
required

Image file (max 10MB)

model
string
required
Example:

"Nanonets_Ocr_S_F16"

language
string

Target language

format
enum<string>

Output format

Available options:
text,
json
return_result_in_response
boolean
webhook_url
string
Maximum string length: 2048

Response

OCR job created

data
object