MENU navbar-image
bash javascript

Introduction to image to text free api

welcome to Image to text converter free api. You can use our free api by signing up.

This documentation aims to provide all the information you need to work with our imagetotext.io.

Base URL

https://www.imagetotext.io

Authenticating requests

This API is authenticated by sending an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Endpoints

GET api/getUserInfo

requires authentication

Example request:
curl --request GET \
    --get "https://www.imagetotext.io/api/getUserInfo" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://www.imagetotext.io/api/getUserInfo"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (401, Unauthenticated):

{
    "message": "Unauthenticated"
}
 

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 59
access-control-allow-origin: *
 
{
    "id": 1,
    "name": "Peer",
    "email": "[email protected]",
    "member_since": "2021-09-11T20:29:33.000000Z",
    "profile_photo_url": "https://ui-avatars.com/api/?name=Peer&color=7F9CF5&background=EBF4FF",
    "limit_used": 1,
    "total_calls": 100
}
 

Request   

GET api/getUserInfo

POST api/conversion/getImageText

requires authentication

Example request:
curl --request POST \
    "https://www.imagetotext.io/api/conversion/getImageText" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://www.imagetotext.io/api/conversion/getImageText"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "POST",
    headers,
}).then(response => response.json());

Example response (422):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 58
access-control-allow-origin: *
 
{
    "message": "The given data was invalid.",
    "errors": {
        "file": [
            "validation.required"
        ]
    }
}
 

Request   

POST api/conversion/getImageText

GET api/conversion/getListing

requires authentication

Example request:
curl --request GET \
    --get "https://www.imagetotext.io/api/conversion/getListing" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"
const url = new URL(
    "https://www.imagetotext.io/api/conversion/getListing"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):

Show headers
cache-control: no-cache, private
content-type: application/json
x-ratelimit-limit: 60
x-ratelimit-remaining: 57
access-control-allow-origin: *
 
{
    "list": {
        "current_page": 1,
        "data": [
            {
                "id": 270,
                "path": "e186e879-2673-483f-801f-396d0bf12d2f.png",
                "result": null,
                "ip": "127.0.0.1",
                "user_id": "1",
                "created_at": "2021-09-27T17:40:24.000000Z",
                "updated_at": "2021-09-27T17:40:24.000000Z",
                "language": null,
                "original_name": null
            }
        ],
        "first_page_url": "https://127.0.0.1:8000/api/conversion/getListing?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "https://127.0.0.1:8000/api/conversion/getListing?page=1",
        "links": [
            {
                "url": null,
                "label": "pagination.previous",
                "active": false
            },
            {
                "url": "https://127.0.0.1:8000/api/conversion/getListing?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "pagination.next",
                "active": false
            }
        ],
        "next_page_url": null,
        "path": "https://127.0.0.1:8000/api/conversion/getListing",
        "per_page": 15,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    }
}
 

Request   

GET api/conversion/getListing