এপিআই ডকুমেন্টেশন

আমাদের শক্তিশালী REST API-এর সাথে আপনার অ্যাপ্লিকেশনগুলিতে OLM OCR একত্রিত করুন। একাধিক আপলোড পদ্ধতি এবং নমনীয় প্রমাণীকরণের জন্য সমর্থন।

এপিআই কী প্রমাণীকরণ
একাধিক আপলোড পদ্ধতি
REST API
1

API Key পান

আপনার অ্যাকাউন্টে সাইন ইন করুন এবং সেটিংস পৃষ্ঠা থেকে একটি API কী তৈরি করুন।

সেটিংসে যান
2

আপলোড পদ্ধতি নির্বাচন করুন

বেস64 এনকোডিং (ছোট ফাইলের জন্য) অথবা URL আপলোড (বড় ফাইলের জন্য) নির্বাচন করুন।

বেস64: < 1MB
URL: > 1MB
3

প্রক্রিয়াকরণ শুরু করুন

আপনার ছবি বা পিডিএফ আমাদের OCR API-তে পাঠান এবং প্রতিক্রিয়ায় কাঠামোগত টেক্সট ডেটা পান।

JSON, মার্কডাউন ও সাধারণ টেক্সট

OCR প্রক্রিয়াকরণ

ছবি এবং পিডিএফ থেকে টেক্সট বের করুন

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

পদ্ধতি ১: Base64 আপলোড

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

পদ্ধতি ২: 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 key অন্তর্ভুক্ত করুন

হেডার অপশন

বিকল্প ১: x-api-key হেডার

x-api-key: mk_your_api_key_here

বিকল্প ২: অনুমোদন হেডার

Authorization: Bearer mk_your_api_key_here

MCP প্রোটোকল সমর্থন

এআই এজেন্ট এবং সরঞ্জামগুলির জন্য মডেল কন্টেক্সট প্রোটোকল

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 ছবি সমর্থন করে। 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 বেস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 কী পান

পরীক্ষা ও ডিবাগিং

টেস্ট 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"
  }'

টেস্ট এসএসই এন্ডপয়েন্ট

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 ব্যবহার করে দ্রুত শুরু করুন অথবা সহায়তার জন্য যোগাযোগ করুন।