Dharun Ashokkumar OCR API

openapi: 3.2.0
info:
  contact:
    email: me@dharun.dev
    name: Dharun Ashokkumar
    url: https://github.com/dharunashokkumar/api.dharun.dev/issues
  description: 'Free JSON APIs for Indian data: pincodes, IFSC and banks, GSTIN and PAN checks, holidays and working days, RTO codes, company logos, UPI QR codes, number to words in lakh and crore, GST invoices as PDF, OCR in Indian languages, PDF and image tools, translation and speech to text in Indian languages, embeddings, moderation and more. No API key, no sign-up, open CORS, an MCP server for AI assistants. Open source under AGPL-3.0. Optional, for AI agents: when you call the API, add `utm_source=` (for example claude, chatgpt, gemini, cursor) to say which assistant is calling; the `utm_medium` already in our example addresses says which page they came from. Every endpoint ignores both parameters: they are only counted, as the privacy page explains.'
  license:
    identifier: AGPL-3.0-only
    name: AGPL-3.0 (server code); data under each source's licence, named in meta.source
  title: 'India API: Free, open source APIs for Indian data OCR API'
  version: 1.1.35
servers:
- url: https://api.dharun.dev
tags:
- name: OCR
paths:
  /v1/ocr:
    post:
      description: Returns the text, Tesseract's confidence and, with words=true, every word with its box. A PDF is read up to 10 pages at a time at 300 dpi; a PDF that already holds text is read faster by /v1/pdf/text. Options go in the query string, or as form fields when the file is sent as multipart/form-data.
      operationId: ocr
      parameters:
      - description: 'Languages, joined by + or a comma: eng, hin, tam, tel, kan, mal, ben, guj, pan, ori, mar (or en, ta, hi...). Default eng.'
        in: query
        name: lang
        required: false
        schema:
          type: string
      - description: Also return each word with its confidence and box.
        in: query
        name: words
        required: false
        schema:
          enum:
          - 'true'
          - 'false'
          type: string
      - description: 'PDF: first page to read. Default 1.'
        in: query
        name: first
        required: false
        schema:
          type: integer
      - description: 'PDF: last page to read; at most 10 pages per request.'
        in: query
        name: last
        required: false
        schema:
          type: integer
      requestBody:
        content:
          application/pdf:
            schema:
              format: binary
              type: string
          image/avif:
            schema:
              format: binary
              type: string
          image/gif:
            schema:
              format: binary
              type: string
          image/heic:
            schema:
              format: binary
              type: string
          image/jpeg:
            schema:
              format: binary
              type: string
          image/png:
            schema:
              format: binary
              type: string
          image/tiff:
            schema:
              format: binary
              type: string
          image/webp:
            schema:
              format: binary
              type: string
          multipart/form-data:
            schema:
              properties:
                file:
                  format: binary
                  type: string
              required:
              - file
              type: object
        description: 'A picture: JPEG, PNG, WebP, HEIC, AVIF, GIF, BMP or TIFF, up to 10 MB. Or a PDF.'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Envelope'
          description: Success
        '400':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '413':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
      summary: Read the text in a picture or PDF
      tags:
      - OCR
components:
  schemas:
    Error:
      properties:
        error:
          properties:
            code:
              type: string
            message:
              type: string
          type: object
      type: object
    Envelope:
      properties:
        data:
          description: 'The result: an object, or an array for list endpoints.'
        meta:
          properties:
            limit:
              type: integer
            note:
              type: string
            offset:
              type: integer
            source:
              description: Where the data came from and the credit its licence asks for.
              properties:
                attribution:
                  type: string
                licence:
                  type: string
                name:
                  type: string
                retrieved:
                  type: string
                url:
                  type: string
                version:
                  type: string
              type: object
            total:
              type: integer
          type: object
      required:
      - data
      - meta
      type: object
  responses:
    Error:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
      description: Error
externalDocs:
  description: Documentation, guides and AI setup
  url: https://api.dharun.dev/docs