Image to Text API
Overview
To use Image to Text, you need an API key. You can get one by creating a free account and visiting your dashboard.
POST Endpoint
https://api.apiverve.com/v1/imagetotextExample
How to call the Image to Text API in different programming languages.
curl -X POST \
"https://api.apiverve.com/v1/imagetotext" \
-H "X-API-Key: your_api_key_here" \
-F "image=@/path/to/image.jpg"const formData = new FormData();
formData.append('image', fileInput.files[0]);
const response = await fetch('https://api.apiverve.com/v1/imagetotext', {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here'
},
body: formData
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here'
}
files = {
'image': open('/path/to/image.jpg', 'rb')
}
response = requests.post('https://api.apiverve.com/v1/imagetotext', headers=headers, files=files)
data = response.json()
print(data)package main
import (
"bytes"
"fmt"
"io"
"mime/multipart"
"net/http"
"os"
)
func main() {
file, _ := os.Open("/path/to/image.jpg")
defer file.Close()
body := &bytes.Buffer{}
writer := multipart.NewWriter(body)
part, _ := writer.CreateFormFile("image", "image.jpg")
io.Copy(part, file)
writer.Close()
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/imagetotext", body)
req.Header.Set("X-API-Key", "your_api_key_here")
req.Header.Set("Content-Type", writer.FormDataContentType())
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
respBody, _ := io.ReadAll(resp.Body)
fmt.Println(string(respBody))
}{
"status": "ok",
"error": null,
"data": {
"text": "Ayear after that (in 2021) I hired somebody tpHfelp me write blog posts for\nmy personal website.\n\nThe point is, | like reinvesting the money | make\nback into my business.",
"confidence": 88,
"words": 28,
"characters": 170,
"lines": 5
}
}Authentication
The Image to Text API requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_hereInteractive API Playground
Test the Image to Text API directly in your browser with live requests and responses.
File Upload Required
multipart/form-data. Do not use Content-Type: application/json for Image to Text.| Property | Value |
|---|---|
| Field Name | image |
| Accepted Types | .jpg, .jpeg, .png, .gif |
| Max File Size | 5MB |
curl -X POST "https://api.apiverve.com/v1/imagetotext" \
-H "X-API-Key: your_api_key_here" \
-F "image=@/path/to/your/file"const formData = new FormData();
formData.append('image', fileInput.files[0]);
const response = await fetch('https://api.apiverve.com/v1/imagetotext', {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here'
},
body: formData
});
const data = await response.json();
console.log(data);Parameters
The Image to Text API supports multiple query options. Use one of the following:
Option 1: Extract Text from Image
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
image | string | required | Upload an image file to extract text from (supported formats: JPG, PNG, GIF, max 5MB) | - | - |
Option 2: Extract Text from URL
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
url | string | required | The URL of the image to extract text from | - |
Response
The Image to Text API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.
Other Response Formats
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>ok</status>
<error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<data>
<text>Ayear after that (in 2021) I hired somebody tpHfelp me write blog posts for
my personal website.
The point is, | like reinvesting the money | make
back into my business.</text>
<confidence>88</confidence>
<words>28</words>
<characters>170</characters>
<lines>5</lines>
</data>
</response>
status: ok
error: null
data:
text: |-
Ayear after that (in 2021) I hired somebody tpHfelp me write blog posts for
my personal website.
The point is, | like reinvesting the money | make
back into my business.
confidence: 88
words: 28
characters: 170
lines: 5
| key | value |
|---|---|
| text | Ayear after that (in 2021) I hired somebody tpHfelp me write blog posts for |
| my personal website. | |
| The point is | | like reinvesting the money | make |
| back into my business. | |
| confidence | 88 |
| words | 28 |
| characters | 170 |
| lines | 5 |
Response Structure
All API responses follow a consistent structure with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
error | string | null | Contains error message if status is "error", otherwise null | null |
data | object | null | Contains the API response data if successful, otherwise null | {...} |
Learn more about response formats →
Response Data Fields
When the request is successful, the data object contains the following fields:
| Field | Type | Sample Value | Description |
|---|---|---|---|
text | string | Extracted text content from the image using OCR | |
confidencePremium | number | OCR confidence level as percentage (0-100) | |
wordsPremium | number | Total number of words extracted from image | |
charactersPremium | number | Total character count in extracted text | |
linesPremium | number | Number of lines detected in extracted text |
Headers
Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →
CORS Support
The Image to Text API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →
Rate Limiting
Image to Text requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →
Error Codes
The Image to Text API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →
SDKs for Image to Text
Official Image to Text packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
Image to Text works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →
Frequently Asked Questions
How do I get an API key for Image to Text?
How many credits does Image to Text cost?
Each successful Image to Text API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful image to text lookups.
Can I use Image to Text in production?
The free plan is for testing and development only. For production use of Image to Text, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.
Can I use Image to Text from a browser?
What happens if I exceed my Image to Text credit limit?
When you reach your monthly credit limit, Image to Text API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.








