APIドキュメント

OLM OCRを強力なREST APIでアプリケーションに統合します。複数のアップロード方法と柔軟な認証をサポート。

APIキー認証
複数のアップロード方法
REST API
1

APIキーを取得

アカウントにサインインし、設定ページからAPIキーを生成してください。

設定に移動
2

アップロード方法を選択

Base64エンコーディング(小ファイル向け)またはURLアップロード(大ファイル向け)を選択してください。

Base64:< 1MB
URL:> 1MB
3

処理を開始

画像またはPDFをOCR APIに送信すると、構造化されたテキストデータが返されます。

JSON、Markdown、プレーンテキスト

OCR処理

画像とPDFからテキストを抽出

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

方法1:Base64アップロード

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

方法2:URLアップロード

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

レスポンス

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

認証

リクエストにAPIキーを含める

ヘッダーオプション

オプション1:x-api-keyヘッダー

x-api-key: mk_your_api_key_here

オプション2:Authorizationヘッダー

Authorization: Bearer mk_your_api_key_here

MCPプロトコルサポート

AIエージェントとツール用のモデルコンテキストプロトコル

MCP

HTTP/JSON-RPCエンドポイント:

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

SSEストリーミングエンドポイント:

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

プロトコルの機能

HTTPトランスポート

  • HTTP POST経由のJSON-RPC 2.0
  • 同期リクエスト/レスポンス
  • Webクライアント向けCORS有効化
  • APIキー認証

SSEトランスポート

  • Server-Sent Eventsストリーミング
  • リアルタイム双方向通信
  • イベントドリブンメッセージ処理
  • 永続的な接続のサポート

利用可能なMCPツール

🔍 extract_text

OCRを使用して、ドキュメントや画像からテキストを抽出します。PDFファイル、JPEG、PNG、WebP画像をサポートしています。base64データとURLの両方を受け入れます(同期処理)

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

推奨ワークフロー

小規模ドキュメント/画像(1MB未満):
extract_text base64データ(PDF、JPEG、PNG、WebP)を使用
大きなドキュメント/画像(1MB以上):
extract_text URLを使用
サポートされているファイル形式:
PDF documents, JPEG/JPG images, PNG images, WebP images

クライアント統合

Cursor/Claude Desktop

開発

カーソルでMCPツールを使用して、画像からコード分析とドキュメント抽出を行う

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

カーソルでの使用:

ショートカットを使用: @ocr
大小ファイル向けのワークフローサポート

カスタムMCPクライアント

高度な設定

HTTP/SSEエンドポイントを使用して、独自のMCPクライアントを構築するか、他のAIツールと統合します。

汎用クライアント設定: 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"]
  }
}

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

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

認証

すべてのMCPリクエストには、これらのいずれかの方法を使用したAPIキー認証が必要です:

  • x-api-key: mk_your_api_key (ヘッダー)
  • Authorization: Bearer mk_your_api_key (ヘッダー)
  • FETCH_MCP_SERVER_API_KEY=mk_your_api_key (環境変数)

APIキーはこちらから取得

テストとデバッグ

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

SSEエンドポイントのテスト

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

コード例

すぐに使えるコードスニペット

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

ヘルプが必要ですか?

APIですぐに開始するか、サポートにお問い合わせください。