Documentação da API

Integre o OLM OCR em seus aplicativos com nossa poderosa API REST. Suporte para vários métodos de upload e autenticação flexível.

Autenticação da Chave da API
Múltiplos Métodos de Upload
API REST
1

Obter chave de API

Faça login na sua conta e gere uma chave de API na página de configurações.

Ir para configurações
2

Escolha o Método de Upload

Escolha entre codificação Base64 (para arquivos pequenos) ou upload por URL (para arquivos grandes).

Base64: < 1MB
URL: > 1MB
3

Iniciar Processamento

Envie suas imagens ou PDFs para nossa API OCR e receba dados de texto estruturados como resposta.

JSON, Markdown e texto simples

Processamento OCR

Extraia texto de imagens e PDFs

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

Método 1: Upload Base64

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

Método 2: Upload por URL

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

Resposta

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

Autenticação

Inclua sua chave de API nas solicitações

Opções de cabeçalho

Opção 1: cabeçalho x-api-key

x-api-key: mk_your_api_key_here

Opção 2: cabeçalho Authorization

Authorization: Bearer mk_your_api_key_here

Suporte ao protocolo MCP

Protocolo de contexto do modelo para agentes e ferramentas de IA

MCP

Endpoint HTTP/JSON-RPC:

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

Endpoint de streaming SSE:

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

Recursos do protocolo

Transporte HTTP

  • • JSON-RPC 2.0 via HTTP POST
  • • Requisição/resposta síncrona
  • • CORS habilitado para clientes web
  • • Autenticação de chave de API

Transporte SSE

  • • Streaming de eventos enviados pelo servidor (SSE)
  • • Comunicação bidirecional em tempo real
  • • Manipulação de mensagens orientada a eventos
  • • Suporte para conexão persistente

Ferramentas MCP disponíveis

🔍 extract_text

Extraia texto de documentos e imagens usando OCR. Suporta arquivos PDF, imagens JPEG, PNG, WebP. Aceita dados base64 e URLs (processamento síncrono)

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

Fluxos de trabalho recomendados

Documentos/Imagens pequenos (<1MB):
extract_text com dados base64 (PDF, JPEG, PNG, WebP)
Documentos/Imagens grandes (>1MB):
extract_text com URL
Tipos de arquivos suportados:
PDF documents, JPEG/JPG images, PNG images, WebP images

Integrações de clientes

↗

Cursor/Claude Desktop

Desenvolvimento

Use as ferramentas MCP no Cursor para análise de código e extração de documentação de imagens.

Configuração 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"
    ]
  }
}

Uso no Cursor:

• Usar atalhos: @ocr
• Suporte a fluxo de trabalho para arquivos pequenos e grandes

Clientes MCP personalizados

Avançado

Crie seu próprio cliente MCP ou integre-se a outras ferramentas de IA usando nossos endpoints HTTP/SSE.

Configuração genérica do cliente: 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"]
  }
}

Exemplo de cliente HTTP:

// 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: {} }
    }
  })
});

Exemplo de cliente 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);
};

Autenticação

Todas as solicitações MCP exigem autenticação de chave de API usando um desses métodos:

  • x-api-key: mk_your_api_key (cabeçalho)
  • Authorization: Bearer mk_your_api_key (cabeçalho)
  • FETCH_MCP_SERVER_API_KEY=mk_your_api_key (variável de ambiente)

Obtenha sua chave de API aqui

Testes e depuração

Testar endpoint HTTP

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"
  }'

Testar endpoint SSE

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

Recursos Adicionais

Exemplos de Código

Snippets de código prontos para uso

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\"}"

Precisa de Ajuda?

Comece rapidamente com nossa API ou entre em contato para obter suporte.

Obter chave de APIEntre em contato com o suporte por e-mailJunte-se ao Discord