> ## Documentation Index > Fetch the complete documentation index at: https://docs.portkey.ai/docs/llms.txt > Use this file to discover all available pages before exploring further. # OCR > Extract text and structured content from documents (PDFs and images) using OCR models. This endpoint provides a unified interface to document processing models from providers including Mistral AI and Azure AI Foundry. The response contains extracted markdown content for each page, along with optional base64-encoded images of the pages. ## OpenAPI ````yaml post /ocr openapi: 3.0.0 info: title: Portkey API description: >- The Portkey REST API. Please see https://portkey.ai/docs/api-reference for more details. version: 2.0.0 termsOfService: https://portkey.ai/terms contact: name: Portkey Developer Forum url: https://portkey.wiki/community license: name: MIT url: https://github.com/Portkey-AI/portkey-openapi/blob/master/LICENSE servers: - url: https://api.portkey.ai/v1 description: Portkey API Public Endpoint security: - Portkey-Key: [] tags: - name: Assistants description: Build Assistants that can call models and use tools. - name: Audio description: Turn audio into text or text into audio. - name: Chat description: >- Given a list of messages comprising a conversation, the model will return a response. - name: Realtime description: WebSocket proxy for provider Realtime APIs - name: Collections description: Create, List, Retrieve, Update, and Delete collections of prompts. - name: Labels description: Create, List, Retrieve, Update, and Delete labels. - name: Prompt Collections description: Create, List, Retrieve, Update, and Delete prompt collections. - name: PromptPartials description: Create, List, Retrieve, Update, and Delete prompt partials. - name: Prompts description: >- Given a prompt template ID and variables, will run the saved prompt template and return a response. - name: Guardrails description: Create, List, Retrieve, Update, and Delete prompt Guardrails. - name: Completions description: >- Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. - name: Embeddings description: >- Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms. - name: Rerank description: >- Rerank a list of documents based on their relevance to a query. Supported providers include Cohere, Voyage, Jina, Pinecone, Bedrock, and Azure AI. - name: OCR description: >- Extract text and structured content from documents (PDFs and images) using OCR models. Supported providers include Mistral AI and Azure AI Foundry. - name: Fine-tuning description: Manage fine-tuning jobs to tailor a model to your specific training data. - name: Batch description: Create large batches of API requests to run asynchronously. - name: Files description: >- Files are used to upload documents that can be used with features like Assistants and Fine-tuning. - name: Images description: Given a prompt and/or an input image, the model will generate a new image. - name: Models description: List and describe the various models available in the API. - name: Moderations description: >- Given a input text, outputs if the model classifies it as potentially harmful. - name: Configs description: Create, List, Retrieve, and Update your Portkey Configs. - name: Feedback description: Send and Update any feedback. - name: Logs description: Custom Logger to add external logs to Portkey. - name: Integrations description: Create, List, Retrieve, Update, and Delete your Portkey Integrations. - name: Integrations > Workspaces description: Manage workspace access for your Portkey Integrations. - name: Integrations > Models description: Manage model access for your Portkey Integrations. - name: Providers description: Create, List, Retrieve, Update, and Delete your Portkey Providers. - name: Virtual-keys description: Create, List, Retrieve, Update, and Delete your Portkey Virtual keys. - name: Users description: Create and manage users. - name: User-invites description: Create and manage user invites. - name: Workspaces description: Create and manage workspaces. - name: Workspaces > Members description: Create and manage workspace members. - name: MCP Integrations description: Create, List, Retrieve, Update, and Delete MCP Integrations. - name: MCP Integrations > Workspaces description: Manage workspace access for MCP Integrations. - name: MCP Integrations > Capabilities description: List and manage capabilities for MCP Integrations. - name: MCP Integrations > Metadata description: Get MCP Integration metadata and sync info. - name: MCP Servers description: >- Create, List, Retrieve, Update, and Delete MCP Servers (workspace instances of MCP Integrations). - name: MCP Servers > Capabilities description: List and manage capabilities for MCP Servers. - name: MCP Servers > User Access description: List and manage user access for MCP Servers. - name: MCP Servers > Connections description: List and manage user connections for MCP Servers. - name: Api-Keys description: Create, List, Retrieve, Update, and Delete your Portkey API keys. - name: Logs Export description: Exports logs service. - name: Audit Logs description: Get audit logs for your Portkey account. - name: Analytics description: >- Get analytics over different data points like requests, costs, tokens, etc. - name: Analytics > Graphs description: Get data points for graphical representation. - name: Analytics > Summary description: Get overall summary for the selected time bucket. - name: Analytics > Groups description: Get grouped metrics for the selected time bucket. - name: Usage Limits Policies description: Manage usage limits policies to control total usage over time - name: Rate Limits Policies description: Manage rate limits policies to control request or token rates - name: Model Pricing description: Model pricing configurations for 2300+ LLMs across 40+ providers - name: Secret-References description: >- Create, List, Retrieve, Update, and Delete secret references to external secret managers. - name: Deployments description: >- Register, List, Retrieve, Update, and Delete self-hosted Gateway deployments. paths: /ocr: servers: - url: https://api.portkey.ai/v1 description: Portkey API Public Endpoint - url: SELF_HOSTED_GATEWAY_URL description: Self-Hosted Gateway URL post: tags: - OCR summary: OCR description: > Extract text and structured content from documents (PDFs and images) using OCR models. This endpoint provides a unified interface to document processing models from providers including Mistral AI and Azure AI Foundry. The response contains extracted markdown content for each page, along with optional base64-encoded images of the pages. operationId: createOcr parameters: - $ref: '#/components/parameters/PortkeyTraceId' - $ref: '#/components/parameters/PortkeySpanId' - $ref: '#/components/parameters/PortkeyParentSpanId' - $ref: '#/components/parameters/PortkeySpanName' - $ref: '#/components/parameters/PortkeyMetadata' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateOcrRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/CreateOcrResponse' security: - Portkey-Key: [] Virtual-Key: [] - Portkey-Key: [] Provider-Auth: [] Provider-Name: [] - Portkey-Key: [] Config: [] - Portkey-Key: [] Provider-Auth: [] Provider-Name: [] Custom-Host: [] x-code-samples: - lang: curl label: Default source: | curl https://api.portkey.ai/v1/ocr \ -H "x-portkey-api-key: $PORTKEY_API_KEY" \ -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "mistral-ocr-latest", "document": { "type": "document_url", "document_url": "https://example.com/document.pdf" }, "include_image_base64": true }' - lang: python label: Default source: | from portkey_ai import Portkey client = Portkey( api_key = "PORTKEY_API_KEY", virtual_key = "PROVIDER_VIRTUAL_KEY" ) response = client.post( "/ocr", body={ "model": "mistral-ocr-latest", "document": { "type": "document_url", "document_url": "https://example.com/document.pdf" }, "include_image_base64": True } ) for page in response["pages"]: print(f"Page {page['index']}: {page['markdown'][:100]}") - lang: javascript label: Default source: | import Portkey from 'portkey-ai'; const client = new Portkey({ apiKey: 'PORTKEY_API_KEY', virtualKey: 'PROVIDER_VIRTUAL_KEY' }); async function main() { const response = await client.post('/ocr', { model: 'mistral-ocr-latest', document: { type: 'document_url', document_url: 'https://example.com/document.pdf' }, include_image_base64: true }); for (const page of response.pages) { console.log(`Page ${page.index}: ${page.markdown.slice(0, 100)}`); } } main(); - lang: curl label: Self-Hosted source: | curl -X POST "SELF_HOSTED_GATEWAY_URL/ocr" \ -H "Content-Type: application/json" \ -H "x-portkey-api-key: $PORTKEY_API_KEY" \ -H "x-portkey-virtual-key: $PORTKEY_PROVIDER_VIRTUAL_KEY" \ -d '{ "model": "mistral-ocr-latest", "document": { "type": "document_url", "document_url": "https://example.com/document.pdf" }, "include_image_base64": true }' - lang: python label: Self-Hosted source: | from portkey_ai import Portkey client = Portkey( api_key="PORTKEY_API_KEY", virtual_key="PROVIDER_VIRTUAL_KEY", base_url="SELF_HOSTED_GATEWAY_URL" ) response = client.post( "/ocr", body={ "model": "mistral-ocr-latest", "document": { "type": "document_url", "document_url": "https://example.com/document.pdf" }, "include_image_base64": True } ) for page in response["pages"]: print(f"Page {page['index']}: {page['markdown'][:100]}") - lang: javascript label: Self-Hosted source: | import Portkey from 'portkey-ai'; const client = new Portkey({ apiKey: 'PORTKEY_API_KEY', virtualKey: 'PROVIDER_VIRTUAL_KEY', baseURL: 'SELF_HOSTED_GATEWAY_URL' }); async function main() { const response = await client.post('/ocr', { model: 'mistral-ocr-latest', document: { type: 'document_url', document_url: 'https://example.com/document.pdf' }, include_image_base64: true }); for (const page of response.pages) { console.log(`Page ${page.index}: ${page.markdown.slice(0, 100)}`); } } main(); components: parameters: PortkeyTraceId: in: header name: x-portkey-trace-id schema: type: string description: >- An ID you can pass to refer to one or more requests later on. If not provided, Portkey generates a trace ID automatically for each request. [Docs](https://portkey.ai/docs/product/observability/traces) required: false PortkeySpanId: in: header name: x-portkey-span-id schema: type: string description: An ID you can pass to refer to a span under a trace. required: false PortkeyParentSpanId: in: header name: x-portkey-parent-span-id schema: type: string description: Link a child span to a parent span required: false PortkeySpanName: in: header name: x-portkey-span-name schema: type: string description: Name for the Span ID required: false PortkeyMetadata: in: header name: x-portkey-metadata schema: type: object description: Pass any arbitrary metadata along with your request required: false schemas: CreateOcrRequest: type: object description: > Request body for extracting text from documents using OCR. Supported providers include Mistral AI and Azure AI Foundry. properties: model: description: > ID of the model to use for OCR processing. Model availability depends on the provider: - **Mistral AI**: `mistral-ocr-latest`, `mistral-ocr-4-0` - **Azure AI Foundry**: `mistral-ocr-4-0`, `mistral-document-ai-2505`, `mistral-document-ai-2512` type: string example: mistral-ocr-latest document: description: >- The document to process. Specify either a URL or base64-encoded content. type: object properties: type: description: The type of document source. type: string enum: - document_url - image_url example: document_url document_url: description: >- URL of the document to process. Can be an HTTPS URL or a base64 data URI (e.g. `data:application/pdf;base64,...`). type: string example: https://example.com/document.pdf image_url: description: URL of an image to process. type: string required: - type include_image_base64: description: >- Whether to include base64-encoded images of each page in the response. type: boolean default: false image_limit: description: >- Maximum number of pages to process. If not specified, all pages are processed. type: integer minimum: 1 image_min_size: description: Minimum size (in pixels) for images to be included in the response. type: integer minimum: 1 pages: description: >- Specific page numbers to process (0-indexed). If not specified, all pages are processed. type: array items: type: integer required: - model - document CreateOcrResponse: type: object description: Response from the OCR endpoint containing extracted content per page. properties: pages: type: array description: Array of processed pages with extracted content. items: $ref: '#/components/schemas/OcrPage' model: type: string description: The model used for OCR processing. example: mistral-ocr-latest usage_info: type: object description: Usage information for the request. properties: pages_processed: type: integer description: Number of pages processed. example: 3 required: - pages - model OcrPage: type: object description: Extracted content from a single page. properties: index: type: integer description: Zero-based page index. example: 0 markdown: type: string description: Extracted content in markdown format. example: |- # Document Title This is the extracted text content... images: type: array description: >- Base64-encoded images found on this page (only present when `include_image_base64` is true). items: type: object properties: id: type: string description: Unique identifier for the image. image_base64: type: string description: Base64-encoded image data. required: - index - markdown securitySchemes: Portkey-Key: type: apiKey in: header name: x-portkey-api-key Virtual-Key: type: apiKey in: header name: x-portkey-virtual-key Provider-Auth: type: http scheme: bearer Provider-Name: type: apiKey in: header name: x-portkey-provider Config: type: apiKey in: header name: x-portkey-config Custom-Host: type: apiKey in: header name: x-portkey-custom-host ````