Tài liệu API

Tích hợp OLM OCR vào các ứng dụng của bạn bằng API REST mạnh mẽ của chúng tôi. Hỗ trợ nhiều phương thức tải lên và xác thực linh hoạt.

Xác thực Khóa API
Nhiều Phương Thức Tải Lên
REST API
1

Lấy Khóa API

Đăng nhập vào tài khoản của bạn và tạo khóa API từ trang cài đặt.

Đến Cài đặt
2

Chọn Phương thức Tải lên

Chọn giữa mã hóa Base64 (cho các tệp nhỏ) hoặc tải lên bằng URL (cho các tệp lớn).

Base64: < 1MB
URL: > 1MB
3

Bắt đầu xử lý

Gửi hình ảnh hoặc tệp PDF của bạn đến API OCR của chúng tôi và nhận dữ liệu văn bản có cấu trúc trong phản hồi.

JSON, Markdown & Plain Text

Đang xử lý OCR

Trích xuất văn bản từ hình ảnh và PDF

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

Phương thức 1: Tải lên Base64

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

Phương pháp 2: Tải lên bằng URL

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

Phản hồi

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

Xác thực

Bao gồm khóa API của bạn trong các yêu cầu

Tùy chọn Tiêu đề

Tùy chọn 1: Tiêu đề x-api-key

x-api-key: mk_your_api_key_here

Tùy chọn 2: Tiêu đề Authorization

Authorization: Bearer mk_your_api_key_here

Hỗ trợ Giao thức MCP

Giao thức Ngữ cảnh Mô hình cho các tác nhân và công cụ AI

MCP

Điểm cuối HTTP/JSON-RPC:

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

Điểm cuối luồng SSE:

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

Tính năng giao thức

Vận chuyển HTTP

  • JSON-RPC 2.0 qua HTTP POST
  • Yêu cầu/phản hồi đồng bộ
  • CORS được bật cho các client web
  • Xác thực khóa API

Vận chuyển SSE

  • Dòng sự kiện Server-Sent Events
  • Giao tiếp hai chiều theo thời gian thực
  • Xử lý tin nhắn theo sự kiện
  • Hỗ trợ kết nối liên tục

Các công cụ MCP khả dụng

🔍 extract_text

Trích xuất văn bản từ tài liệu và hình ảnh bằng OCR. Hỗ trợ các tệp PDF, hình ảnh JPEG, PNG, WebP. Chấp nhận cả dữ liệu base64 và URL (xử lý đồng bộ)

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

Quy trình làm việc được đề xuất

Tài liệu/Hình ảnh nhỏ (<1MB):
extract_text với dữ liệu base64 (PDF, JPEG, PNG, WebP)
Tài liệu/Hình ảnh lớn (>1MB):
extract_text với URL
Các loại tệp được hỗ trợ:
PDF documents, JPEG/JPG images, PNG images, WebP images

Tích hợp Client

Cursor/Claude Desktop

Phát triển

Sử dụng công cụ MCP trong Cursor để phân tích mã và trích xuất tài liệu từ hình ảnh.

Cấu hình 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"
    ]
  }
}

Sử dụng trong Cursor:

Sử dụng phím tắt: @ocr
Hỗ trợ quy trình làm việc cho các tệp tin nhỏ và lớn

Client MCP tùy chỉnh

Nâng cao

Xây dựng client MCP của riêng bạn hoặc tích hợp với các công cụ AI khác bằng cách sử dụng các điểm cuối HTTP/SSE của chúng tôi.

Cấu hình Client chung: 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"]
  }
}

Ví dụ về Client 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: {} }
    }
  })
});

Ví dụ về Client 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);
};

Xác thực

Tất cả các yêu cầu MCP đều yêu cầu xác thực khóa API bằng một trong các phương pháp sau:

  • x-api-key: mk_your_api_key (tiêu đề)
  • Authorization: Bearer mk_your_api_key (tiêu đề)
  • FETCH_MCP_SERVER_API_KEY=mk_your_api_key (biến môi trường)

Lấy khóa API của bạn tại đây

Kiểm tra & Gỡ lỗi

Kiểm tra điểm cuối 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"
  }'

Kiểm tra điểm cuối SSE

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

Ví dụ về mã

Đoạn mã sử dụng ngay

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

Cần Giúp Đỡ?

Bắt đầu nhanh chóng với API của chúng tôi hoặc liên hệ để được hỗ trợ.