Atlas OCR
Atlas OCR API Documentation

Integrate powerful OCR capabilities into your applications

Getting Started

Base URL

bash

Authentication

All API requests must include your API key in the X-API-Key header.

bash

API Endpoints

POST/api/service/ocr
ocr
Perform OCR on document files

Headers

ParameterTypeRequiredDescription
X-API-KeystringRequired

Your API key for authentication

Content-TypestringRequired

multipart/form-data

Default: multipart/form-data

Request Body Parameters

ParameterTypeRequiredDescription
filefileRequired

The document file to process

cache_policystringOptional

Cache policy to use for this request

Default: cache_first

Options:

  • cache_first - Check cache first, then process if not found
  • no_cache - Always process the document, don't use cache
  • cache_only - Only return cached results, don't process
enginestringOptional

OCR engine to use for processing

Default: TESSERACT

Options:

  • TESSERACT - Fast processing, good for clear text
  • EASYOCR - Balanced speed and accuracy
  • DOCTR - High accuracy, good for complex documents
rawbooleanOptional

Whether to return raw OCR results

Default: false

Options:

  • true - Return raw OCR results
  • false - Return processed results
organization_idstringRequired

ID of the organization to process the document for

Responses

200OCRResponseList

Successful OCR processing

json

Error Responses

400ErrorResponse

Bad request - such as an invalid OCR engine option or file parsing error

json
401ErrInvalidAPIKey

Invalid API key

json
403ErrPermissionDeniedResponse

Permission denied

json
500ErrorResponse

Server error

json

Examples

bash

Type Definitions

Type Definitions

Ready to Get Started?

Sign up for an API key and start integrating OCR capabilities into your applications today.