Documentación de la API

Integra OLM OCR en tus aplicaciones con nuestra potente API REST. Soporte para múltiples métodos de subida y autenticación flexible.

Autenticación de clave API
Múltiples métodos de carga
API REST
1

Obtener clave API

Inicie sesión en su cuenta y genere una clave API desde la página de configuración.

Ir a configuración
2

Elija el método de carga

Seleccione entre codificación Base64 (para archivos pequeños) o carga por URL (para archivos grandes).

Base64: < 1MB
URL: > 1MB
3

Iniciar procesamiento

Envíe sus imágenes o archivos PDF a nuestra API OCR y reciba datos de texto estructurados como respuesta.

JSON, Markdown y texto plano

Procesamiento OCR

Extraer texto de imágenes y PDFs

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

Método 1: Subida Base64

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

Método 2: Carga por URL

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

Respuesta

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

Autenticación

Incluye tu clave API en las peticiones

Opciones de encabezado

Opción 1: encabezado x-api-key

x-api-key: mk_your_api_key_here

Opción 2: encabezado de autorización

Authorization: Bearer mk_your_api_key_here

Soporte del protocolo MCP

Protocolo de contexto del modelo para agentes y herramientas de IA

MCP

Endpoint HTTP/JSON-RPC:

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

Punto final de streaming SSE:

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

Características del protocolo

Transporte HTTP

  • • JSON-RPC 2.0 sobre HTTP POST
  • • Solicitud/respuesta síncrona
  • • CORS habilitado para clientes web
  • • Autenticación de clave API

Transporte SSE

  • • Streaming de eventos enviados por el servidor (SSE)
  • • Comunicación bidireccional en tiempo real
  • • Manejo de mensajes basado en eventos
  • • Soporte de conexión persistente

Herramientas MCP disponibles

🔍 extract_text

Extraiga texto de documentos e imágenes utilizando OCR. Admite archivos PDF, imágenes JPEG, PNG, WebP. Acepta datos base64 y URL (procesamiento 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

Flujos de trabajo recomendados

Documentos/Imágenes pequeños (<1MB):
extract_text con datos base64 (PDF, JPEG, PNG, WebP)
Documentos/Imágenes grandes (>1MB):
extract_text con URL
Tipos de archivos soportados:
PDF documents, JPEG/JPG images, PNG images, WebP images

Integraciones de clientes

↗

Cursor/Claude Desktop

Desarrollo

Utilice las herramientas MCP en Cursor para el análisis de código y la extracción de documentación de imágenes.

Configuración de 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 en Cursor:

• Usar atajos: @ocr
• Soporte de flujo de trabajo para archivos pequeños y grandes

Clientes MCP personalizados

Avanzado

Cree su propio cliente MCP o intégrelo con otras herramientas de IA utilizando nuestros endpoints HTTP/SSE.

Configuración genérica del 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"]
  }
}

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

Ejemplo 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);
};

Autenticación

Todas las solicitudes de MCP requieren autenticación de clave API utilizando uno de estos métodos:

  • x-api-key: mk_your_api_key (encabezado)
  • Authorization: Bearer mk_your_api_key (encabezado)
  • FETCH_MCP_SERVER_API_KEY=mk_your_api_key (variable de entorno)

Obtenga su clave API aquí

Pruebas y depuración

Punto final HTTP de prueba

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

Punto final SSE de prueba

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

Recursos adicionales

Ejemplos de código

Fragmentos de código listos para usar

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

¿Necesitas ayuda?

Comienza rápidamente con nuestra API o ponte en contacto con el soporte técnico.

Obtener clave APIContactar con el soporte por correo electrónicoUnirse a Discord