TextVision OCR API Documentation

Introduction

Start with a concise introduction that describes what the API does, the main functionalities it offers, and how developers can benefit from using it.

Example:

Welcome to TextVision OCR API Documentation! Our API allows you to seamlessly integrate optical character recognition capabilities into your applications. This service is designed to extract text from images efficiently, making it ideal for a wide range of applications including document management, accessibility solutions, and automated data entry.

Getting Started

Provide a step-by-step guide to help new users begin using your API. This section should cover how to sign up, authenticate, and make their first API call.

Example:

  1. Create an Account: To use the TextVision OCR API, you need to first create an account. Sign up here.
  2. Get Your API Key: Once you have created your account, go to your dashboard to find your API key. This key will be used to authenticate your API requests.

Authentication

Explain the authentication process clearly, including how the API key should be included in API requests.

Example:

Our API uses API keys to allow access to the service. You must include your API key in the body of each request:

API Endpoint

Detail the main endpoint of your API, including the HTTP method, URL, required and optional parameters, request examples, and what response to expect.

Example:

POST /wp-json/ocr_ai_image/v1/extract_text_from_image

This endpoint processes images to extract text. Here’s how you can make a request:

Request:

curl --location 'https://ocr.onlevelup.com//wp-json/ocr_ai_image/v1/extract_text_from_image' \
--header 'Content-Type: application/json' \
--data '{
    "image_url": "https://ocr.onlevelup.com/wp-content/uploads/2024/04/testocr.png",
    "key_api": "Your API key"
 }'

Required Parameters:

  • image_url: The URL of the image from which text needs to be extracted.
  • key_api: Your API key.

Response:


{
    "text": "Extracted text from the image",
}

Error Response:

{
    "error": true,
    "message": "Description of the error"
}

Example Use Case

Illustrate a practical example or a common use case to show how your API can be used in real-world scenarios.

Example:

Use Case: Digitizing Printed Reports

Imagine you have a collection of printed financial reports. Using the TextVision OCR API, you can convert these printed documents into digital text, which can then be analyzed or stored in a digital document management system.

Support and Resources

Provide information on how users can get support if they encounter issues or have questions. Include links to forums, support email addresses, or a FAQ section.

Example:

For more information or support, please visit our FAQ page or contact our support team at contact@ocr.onlevelup.com.

This structured approach not only enhances the user experience by making the documentation easy to navigate but also ensures that developers have all the information they need to start using your API effectively right away.