Skip to main content
POST
/
api
/
v1
/
client
/
img2txt
cURL
curl --request POST \
  --url https://api.deapi.ai/api/v1/client/img2txt \
  --header 'Accept: <accept>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form image='@example-file' \
  --form model=Nanonets_Ocr_S_F16 \
  --form language=en \
  --form format=text \
  --form return_result_in_response=false \
  --form webhook_url=https://your-server.com/webhooks/deapi
{
  "data": {
    "request_id": "c08a339c-73e5-4d67-a4d5-231302fbff9a"
  }
}
Prerequisite: To ensure a successful request, you must first consult the Model Selection endpoint to identify a valid model slug, check specific limits and features, and verify LoRA availability.

Authorizations

​
Authorization
string
header
required

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

Headers

​
Accept
enum<string>
default:application/json
required
Available options:
application/json

Body

multipart/form-data

Image to text conversion parameters

​
image
file
required

Image file to extract text from. Supported formats: JPG, JPEG, PNG, GIF, BMP, WebP. Maximum file size: 10 MB.

​
model
string
required

The OCR model to use for text extraction

Example:

"Nanonets_Ocr_S_F16"

​
language
string | null

Language code for OCR processing (optional)

Example:

"en"

​
format
enum<string> | null

Output format for extracted text

Available options:
text,
json
Example:

"text"

​
return_result_in_response
boolean | null
default:false

If true, the result will be returned directly in the response instead of only download url. Optional parameter.

Example:

false

​
webhook_url
string<uri> | null

Optional HTTPS URL to receive webhook notifications for job status changes (processing, completed, failed). Must be HTTPS. Max 2048 characters. See Webhook Documentation for payload structure and authentication details.

Maximum string length: 2048
Example:

"https://your-server.com/webhooks/deapi"

Response

ID of the inference request.

​
data
object

Information from success endpoint