एपीआई दस्तावेज़

हमारे शक्तिशाली REST API के साथ OLM OCR को अपने अनुप्रयोगों में एकीकृत करें। कई अपलोड विधियों और लचीले प्रमाणीकरण के लिए समर्थन।

एपीआई कुंजी प्रमाणीकरण
एकाधिक अपलोड तरीके
REST API
1

API कुंजी प्राप्त करें

अपने खाते में साइन इन करें और सेटिंग्स पृष्ठ से एक API कुंजी जनरेट करें।

सेटिंग्स पर जाएं
2

अपलोड विधि चुनें

बेस64 एन्कोडिंग (छोटी फ़ाइलों के लिए) या URL अपलोड (बड़ी फ़ाइलों के लिए) के बीच चयन करें।

Base64: < 1MB
URL: > 1MB
3

प्रसंस्करण शुरू करें

अपनी छवियों या PDF को हमारे OCR API पर भेजें और प्रतिक्रिया में संरचित टेक्स्ट डेटा प्राप्त करें।

JSON, Markdown और सादा टेक्स्ट

ओसीआर प्रसंस्करण

छवियों और 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: Bearer mk_your_api_key_here

MCP प्रोटोकॉल समर्थन

AI एजेंटों और उपकरणों के लिए मॉडल संदर्भ प्रोटोकॉल

MCP

HTTP/JSON-RPC एंडपॉइंट:

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

एसएसई स्ट्रीमिंग एंडपॉइंट:

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

प्रोटोकॉल सुविधाएँ

HTTP परिवहन

  • HTTP POST पर JSON-RPC 2.0
  • समकालिक अनुरोध/प्रतिक्रिया
  • वेब क्लाइंट के लिए CORS सक्षम
  • API कुंजी प्रमाणीकरण

एसएसई परिवहन

  • सर्वर-प्रेषित इवेंट स्ट्रीमिंग
  • वास्तविक समय द्विदिश संचार
  • इवेंट-संचालित संदेश हैंडलिंग
  • स्थायी कनेक्शन समर्थन

उपलब्ध MCP उपकरण

🔍 extract_text

OCR का उपयोग करके दस्तावेज़ों और छवियों से टेक्स्ट निकालें। PDF फ़ाइलों, JPEG, PNG, WebP छवियों का समर्थन करता है। बेस64 डेटा और 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 बेस64 डेटा के साथ (पीडीएफ, जेपीईजी, पीएनजी, वेबपी)
बड़े दस्तावेज़/छवियाँ (>1MB):
extract_text यूआरएल के साथ
समर्थित फ़ाइल प्रकार:
PDF documents, JPEG/JPG images, PNG images, WebP images

क्लाइंट एकीकरण

Cursor/Claude Desktop

विकास

कोड विश्लेषण और छवियों से दस्तावेज़ निष्कर्षण के लिए कर्सर में एमसीपी टूल का उपयोग करें।

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

एसएसई क्लाइंट उदाहरण:

// 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 कुंजी यहां प्राप्त करें

परीक्षण और डिबगिंग

एचटीटीपी एंडपॉइंट का परीक्षण करें

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

एसएसई एंडपॉइंट का परीक्षण करें

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

कोड उदाहरण

उपयोग के लिए तैयार कोड स्निपेट

पायथन

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 के साथ तुरंत आरंभ करें या समर्थन के लिए संपर्क करें।