API 문서

강력한 REST API를 사용하여 OLM OCR을 애플리케이션에 통합하세요. 여러 업로드 방법과 유연한 인증을 지원합니다.

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
  • 동기식 요청/응답
  • 웹 클라이언트에 대해 CORS 활성화
  • API 키 인증

SSE 전송

  • 서버 전송 이벤트 스트리밍
  • 실시간 양방향 통신
  • 이벤트 기반 메시지 처리
  • 지속적인 연결 지원

사용 가능한 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를 사용하여 빠르게 시작하거나 지원을 요청하세요.