Documentation API

Intégrez Mistral OCR dans vos applications grâce à notre puissante API REST. Prise en charge de plusieurs méthodes de téléchargement et authentification flexible.

Authentification par clé API
Plusieurs méthodes de téléchargement
API REST
1

Obtenir une clé API

Connectez-vous à votre compte et générez une clé API depuis la page des paramètres.

Aller aux paramètres
2

Choisir la méthode de téléchargement

Choisissez entre l'encodage Base64 (pour les petits fichiers) ou le téléversement par URL (pour les fichiers volumineux).

Base64 : < 1 Mo
URL : > 1 Mo
3

Démarrer le traitement

Envoyez vos images ou PDF à notre API OCR et recevez des données textuelles structurées en réponse.

JSON, Markdown et texte brut

Traitement OCR

Extraire le texte des images et des PDF

POST
POST https://www.mistralocr.app/api/ocr/process

Méthode 1 : Téléchargement Base64

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

Méthode 2 : Téléversement par URL

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

Réponse

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

Authentification

Incluez votre clé API dans les requêtes

Options d'en-tête

Option 1 : en-tête x-api-key

x-api-key: mk_your_api_key_here

Option 2 : en-tête d'autorisation

Authorization: Bearer mk_your_api_key_here

Prise en charge du protocole MCP

Protocole de contexte de modèle pour les agents et outils d'IA

MCP

Point de terminaison HTTP/JSON-RPC:

POST https://www.mistralocr.app/api/mcp

Point de terminaison de streaming SSE:

GET https://www.mistralocr.app/api/mcp

Fonctionnalités du protocole

Transport HTTP

  • • JSON-RPC 2.0 via HTTP POST
  • • Requête/réponse synchrone
  • • CORS activé pour les clients web
  • • Authentification par clé API

Transport SSE

  • • Streaming d'événements envoyés par le serveur (SSE)
  • • Communication bidirectionnelle en temps réel
  • • Gestion des messages basée sur les événements
  • • Prise en charge des connexions persistantes

Outils MCP disponibles

🔍 extract_text

Extrayez du texte de documents et d'images en utilisant l'OCR. Prend en charge les fichiers PDF, les images JPEG, PNG, WebP. Accepte les données base64 et les URL (traitement synchrone)

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

Flux de travail recommandés

Petits documents/images (<1 Mo):
extract_text avec des données base64 (PDF, JPEG, PNG, WebP)
Documents/Images volumineux (>1 Mo):
extract_text avec URL
Types de fichiers pris en charge:
PDF documents, JPEG/JPG images, PNG images, WebP images

Intégrations client

↗

Cursor/Claude Desktop

Développement

Utiliser les outils MCP dans Cursor pour l'analyse du code et l'extraction de la documentation à partir d'images.

Configuration MCP: cursor_mcp_config.json

{
  "mcp": {
    "servers": {
      "mistral-ocr": {
        "url": "https://www.mistralocr.app/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"
    ]
  }
}

Utilisation dans Cursor:

• Utiliser les raccourcis: @ocr
• Prise en charge du flux de travail pour les fichiers petits et volumineux

Clients MCP personnalisés

Avancé

Créez votre propre client MCP ou intégrez-vous à d'autres outils d'IA en utilisant nos points de terminaison HTTP/SSE.

Configuration client générique: mcp_config.json

{
  "mcp": {
    "servers": {
      "mistral-ocr": {
        "url": "https://www.mistralocr.app/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"]
  }
}

Exemple de client HTTP:

// Initialize MCP connection
const response = await fetch('https://www.mistralocr.app/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: {} }
    }
  })
});

Exemple de client SSE:

// Connect to SSE endpoint
const eventSource = new EventSource(
  'https://www.mistralocr.app/api/mcp?' +
  'api_key=mk_your_api_key'
);

eventSource.onmessage = (event) => {
  const data = JSON.parse(event.data);
  console.log('Received:', data);
};

Authentification

Toutes les requêtes MCP nécessitent une authentification par clé API en utilisant l'une de ces méthodes:

  • x-api-key: mk_your_api_key (en-tête)
  • Authorization: Bearer mk_your_api_key (en-tête)
  • FETCH_MCP_SERVER_API_KEY=mk_your_api_key (variable d'environnement)

Obtenez votre clé API ici

Tests et débogage

Tester le point de terminaison HTTP

curl -X POST https://www.mistralocr.app/api/mcp \
  -H "Content-Type: application/json" \
  -H "x-api-key: mk_your_api_key" \
  -d '{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "tools/list"
  }'

Tester le point de terminaison SSE

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

Ressources supplémentaires

Exemples de code

Extraits de code prêts à l'emploi

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.mistralocr.app/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.mistralocr.app/api/ocr/process \
  -H "x-api-key: mk_your_api_key" \
  -H "Content-Type: application/json" \
  -d "{\"image\": \"$IMAGE_DATA\"}"

Besoin d'aide ?

Commencez rapidement avec notre API ou contactez-nous pour obtenir de l'aide.

Obtenir une clé APIContacter le support par e-mailRejoindre Discord