Dokumentace API

Integrujte OLM OCR do svých aplikací s naším výkonným REST API. Podpora více metod nahrávání a flexibilní ověřování.

Autorizace pomocí klíče API
Více metod nahrávání
REST API
1

Získat klíč API

Přihlaste se ke svému účtu a vygenerujte klíč API na stránce nastavení.

Přejít na nastavení
2

Zvolte metodu nahrávání

Vyberte mezi kódováním Base64 (pro malé soubory) nebo nahráním z adresy URL (pro velké soubory).

Base64: < 1MB
URL: > 1 MB
3

Zahájit zpracování

Pošlete své obrázky nebo PDF do našeho OCR API a obdržíte strukturovaná textová data v odpovědi.

JSON, Markdown a prostý text

Zpracování OCR

Extrahujte text z obrázků a PDF

POST
POST https://www.freeolmocr.com/api/ocr/process

Metoda 1: Nahrávání Base64

{
  "image": "base64_encoded_image_data",
  "options": {
    "format": "text" # json, text, markdown
  }
}

Metoda 2: Nahrání z adresy URL

{
  "imageUrl": "https://img.freeolmocr.com/mistral-ocr/...",
  "options": {
    "format": "text" # json, text, markdown
  }
}

Odpověď

{
  "success": true,
  "userId": "user_123",
  "inputSource": "base64",
  "extractedText": "Extracted text content...",
  "confidence": 0.95,
  "processingTime": 1.2,
  "creditsUsed": 1
}

Autorizace

Zahrňte svůj klíč API do požadavků

Možnosti záhlaví

Možnost 1: hlavička x-api-key

x-api-key: mk_your_api_key_here

Možnost 2: hlavička Authorization

Authorization: Bearer mk_your_api_key_here

Podpora protokolu MCP

Protokol kontextu modelu pro agenty a nástroje AI

MCP

Koncový bod HTTP/JSON-RPC:

POST https://www.freeolmocr.com/api/mcp

Koncový bod streamování SSE:

GET https://www.freeolmocr.com/api/mcp

Funkce protokolu

HTTP transport

  • JSON-RPC 2.0 přes HTTP POST
  • Synchronní požadavek/odpověď
  • CORS povolen pro webové klienty
  • Ověření pomocí klíče API

Transport SSE

  • Streamování událostí odeslaných serverem
  • Obousměrná komunikace v reálném čase
  • Zpracování zpráv řízené událostmi
  • Podpora trvalého spojení

Dostupné nástroje MCP

🔍 extract_text

Extrahujte text z dokumentů a obrázků pomocí OCR. Podporuje soubory PDF, JPEG, PNG, WebP. Akceptuje data base64 i adresy URL (synchronní zpracování)

Parameters:
- image_source (object, required):
- type: 'base64' | 'url'
- data: base64 string or file URL
- filename: document.pdf, image.jpg, etc. (optional)
- output_format (string, optional): 'text'|'json'|'markdown'

Supported formats: PDF, JPEG, PNG, WebP

Doporučené pracovní postupy

Malé dokumenty/obrázky (<1MB):
extract_text s daty base64 (PDF, JPEG, PNG, WebP)
Velké dokumenty/obrázky (>1MB):
extract_text s URL
Podporované typy souborů:
PDF documents, JPEG/JPG images, PNG images, WebP images

Integrace klientů

Cursor/Claude Desktop

Vývoj

Použijte nástroje MCP v kurzoru pro analýzu kódu a extrakci dokumentace z obrázků.

Konfigurace MCP: cursor_mcp_config.json

{
  "mcp": {
    "servers": {
      "mistral-ocr": {
        "url": "https://www.freeolmocr.com/api/mcp",
        "transport": "http",
        "headers": {
          "x-api-key": "mk_your_api_key_here",
          "Content-Type": "application/json"
        },
        "capabilities": { "tools": true }
      }
    }
  },
  "shortcuts": {
    "ocr": "@mistral-ocr extract_text"
  },
  "workflows": {
    "large_file_ocr": [
      "extract_text with public_url"
    ],
    "small_file_ocr": [
      "extract_text with base64 data"
    ]
  }
}

Použití v kurzoru:

Používat zkratky: @ocr
Podpora pracovních postupů pro malé i velké soubory

Vlastní klienti MCP

Pokročilé

Vytvořte si vlastního klienta MCP nebo jej integrujte s dalšími nástroji AI pomocí našich HTTP/SSE koncových bodů.

Obecná konfigurace klienta: mcp_config.json

{
  "mcp": {
    "servers": {
      "mistral-ocr": {
        "url": "https://www.freeolmocr.com/api/mcp",
        "transport": "http",
        "authentication": {
          "type": "api_key",
          "header": "x-api-key",
          "key": "mk_your_api_key_here"
        },
        "capabilities": {
          "tools": true,
          "resources": false,
          "prompts": false
        },
        "metadata": {
          "name": "Mistral OCR",
          "description": "OCR service for PDF and image text extraction",
          "version": "2.0.0"
        }
      }
    }
  },
  "client": {
    "timeout": 30000,
    "retries": 3,
    "transport_fallback": ["http", "sse"]
  }
}

Příklad HTTP klienta:

// Initialize MCP connection
const response = await fetch('https://www.freeolmocr.com/api/mcp', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'mk_your_api_key'
  },
  body: JSON.stringify({
    jsonrpc: '2.0',
    id: 1,
    method: 'initialize',
    params: {
      protocolVersion: '2024-11-05',
      capabilities: { tools: {} }
    }
  })
});

Příklad klienta SSE:

// Connect to SSE endpoint
const eventSource = new EventSource(
  'https://www.freeolmocr.com/api/mcp?' +
  'api_key=mk_your_api_key'
);

eventSource.onmessage = (event) => {
  const data = JSON.parse(event.data);
  console.log('Received:', data);
};

Autorizace

Všechny požadavky MCP vyžadují ověření pomocí klíče API pomocí jedné z těchto metod:

  • x-api-key: mk_your_api_key (záhlaví)
  • Authorization: Bearer mk_your_api_key (záhlaví)
  • FETCH_MCP_SERVER_API_KEY=mk_your_api_key (proměnná prostředí)

Získejte svůj klíč API zde

Testování a ladění

Testovací HTTP koncový bod

curl -X POST https://www.freeolmocr.com/api/mcp \
  -H "Content-Type: application/json" \
  -H "x-api-key: mk_your_api_key" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/list"
  }'

Testovací koncový bod SSE

curl -N -H "Accept: text/event-stream" \
  -H "x-api-key: mk_your_api_key" \
  https://www.freeolmocr.com/api/mcp

Příklady kódu

Hotové úryvky kódu

Python

import requests
import base64

# Base64 method
with open('image.jpg', 'rb') as f:
    image_data = base64.b64encode(f.read()).decode()

response = requests.post(
    'https://www.freeolmocr.com/api/ocr/process',
    headers={'x-api-key': 'mk_your_api_key'},
    json={'image': image_data}
)

result = response.json()
print(result['extractedText'])

cURL

# Base64 method
IMAGE_DATA=$(base64 -i image.jpg)
curl -X POST https://www.freeolmocr.com/api/ocr/process \
  -H "x-api-key: mk_your_api_key" \
  -H "Content-Type: application/json" \
  -d "{\"image\": \"$IMAGE_DATA\"}"

Potřebujete pomoc?

Začněte rychle s naším API nebo se obraťte na podporu.