> ## Documentation Index > Fetch the complete documentation index at: https://docs.getbifrost.ai/llms.txt > Use this file to discover all available pages before exploring further. # Create async OCR job > Submits an OCR request for asynchronous execution. Returns a job ID immediately with HTTP 202. Poll the corresponding GET endpoint with the job ID to retrieve the result. ## OpenAPI ````yaml /openapi/openapi.json post /v1/async/ocr openapi: 3.1.0 info: title: Bifrost API description: > Bifrost HTTP Transport API for AI model inference and gateway management. This API provides a unified interface for interacting with multiple AI providers including OpenAI, Anthropic, Bedrock, Gemini, and more through a single API, along with comprehensive management APIs for configuring and monitoring the gateway. ## API Structure ### Unified Inference API (`/v1/*`) The primary API using Bifrost's unified format. Model parameters use the format `provider/model` (e.g., `openai/gpt-4`, `anthropic/claude-3-opus`). ### Async Inference API (`/v1/async/*`) Submit inference requests for asynchronous execution. Returns a job ID immediately and allows polling for results. Supports all inference types except batches, files, and containers. ### Provider Integration APIs Native provider-format APIs for drop-in compatibility: - `/openai/*` - OpenAI-compatible API - `/anthropic/*` - Anthropic-compatible API - `/genai/*` - Google GenAI (Gemini) compatible API - `/bedrock/*` - AWS Bedrock compatible API - `/cohere/*` - Cohere compatible API ### Framework Integration APIs Multi-provider proxy endpoints for AI frameworks: - `/litellm/*` - LiteLLM proxy with all provider formats - `/langchain/*` - LangChain compatible endpoints - `/pydanticai/*` - PydanticAI compatible endpoints ### Management APIs (`/api/*`) APIs for managing and monitoring the Bifrost gateway: - `/api/config` - Configuration management - `/api/providers` - Provider and API key management - `/api/plugins` - Plugin management - `/api/governance/*` - Virtual keys, teams, customers, budgets, rate limits, routing rules, and pricing overrides - `/api/logs` - Log search and analytics - `/api/mcp/*` - MCP (Model Context Protocol) client management - `/api/session/*` - Authentication and session management - `/api/cache/*` - Cache management - `/health` - Health check endpoint ## Fallbacks Requests can include fallback models that will be tried if the primary model fails. version: 1.0.0 contact: name: Contact Us url: https://getmaxim.ai/bifrost license: name: Apache 2.0 url: https://opensource.org/licenses/Apache-2.0 servers: - url: '{baseUrl}' description: Your Bifrost instance variables: baseUrl: default: http://localhost:8080 description: Base URL of your Bifrost instance (e.g. https://bifrost.mycompany.com) security: - BearerAuth: [] - BasicAuth: [] - ApiKeyAuth: [] tags: - name: Models description: Model listing and information - name: Chat Completions description: Chat-based text generation - name: Text Completions description: Text completion generation - name: Responses description: OpenAI Responses API compatible endpoints - name: OCR description: Optical character recognition for documents and images - name: Rerank description: Document reranking by relevance to a query - name: Embeddings description: Text embedding generation - name: Images description: Image generations, editing, and variations - name: Videos description: Video generation and management - name: Audio description: Speech synthesis and transcription - name: Count Tokens description: Token counting utilities - name: Batch description: Batch processing operations - name: Files description: File management operations - name: Containers description: Container management operations - name: Async Jobs description: Asynchronous job submission and retrieval endpoints - name: OpenAI Integration description: OpenAI-compatible API endpoints (/openai/*) - name: Azure Integration description: Azure OpenAI integration endpoints - name: Anthropic Integration description: Anthropic-compatible API endpoints (/anthropic/*) - name: GenAI Integration description: Google GenAI (Gemini) compatible API endpoints (/genai/*) - name: Bedrock Integration description: AWS Bedrock compatible API endpoints (/bedrock/*) - name: Cohere Integration description: Cohere compatible API endpoints (/cohere/*) - name: LiteLLM Integration description: LiteLLM proxy endpoints with multi-provider support (/litellm/*) - name: LangChain Integration description: LangChain compatible endpoints with multi-provider support (/langchain/*) - name: PydanticAI Integration description: >- PydanticAI compatible endpoints with multi-provider support (/pydanticai/*) - name: Health description: Health check endpoints - name: Configuration description: Configuration management endpoints - name: Session description: Session and authentication endpoints - name: Providers description: Provider management endpoints - name: Plugins description: Plugin management endpoints - name: MCP description: Model Context Protocol endpoints - name: Governance description: Virtual keys, teams, and customers management - name: Logging description: Log search and management endpoints - name: Cache description: Cache management endpoints paths: /v1/async/ocr: post: tags: - Async Jobs summary: Create async OCR job description: > Submits an OCR request for asynchronous execution. Returns a job ID immediately with HTTP 202. Poll the corresponding GET endpoint with the job ID to retrieve the result. operationId: createAsyncOCR parameters: - $ref: '#/components/parameters/AsyncResultTTL' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OCRRequest' responses: '202': description: Job accepted for processing content: application/json: schema: $ref: '#/components/schemas/AsyncJobResponse' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/BifrostError' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/BifrostError' security: - BearerAuth: [] - BasicAuth: [] - VirtualKeyAuth: [] - ApiKeyAuth: [] components: parameters: AsyncResultTTL: name: x-bf-async-job-result-ttl in: header required: false description: > Time-to-live in seconds for the job result after completion. Defaults to 3600 (1 hour). After expiry, the job result is automatically cleaned up. schema: type: integer default: 3600 schemas: OCRRequest: type: object required: - model - document properties: model: type: string description: Model in provider/model format example: mistral/mistral-ocr-latest id: type: string description: Optional unique identifier for the request document: $ref: '#/components/schemas/OCRDocument' fallbacks: type: array items: type: string description: Fallback models in provider/model format include_image_base64: type: boolean description: Whether to include base64-encoded images in the response pages: type: array items: type: integer minimum: 0 description: Specific page indices to process (0-based) image_limit: type: integer minimum: 1 description: Maximum number of images to extract per page image_min_size: type: integer minimum: 1 description: Minimum image size in pixels to extract table_format: type: string description: Format for extracted tables (e.g., "markdown", "html") extract_header: type: boolean description: Whether to extract page headers extract_footer: type: boolean description: Whether to extract page footers confidence_scores_granularity: type: string enum: - page - block - word - document description: Granularity of confidence scores to include in the response bbox_annotation_format: type: object description: >- Format for bounding box annotations. Supports text, json_object, and json_schema modes. required: - type properties: type: type: string enum: - text - json_object - json_schema description: The format type json_schema: type: object description: JSON schema definition (required when type is json_schema) properties: schema: type: object description: The JSON schema name: type: string description: Name of the schema strict: type: boolean description: Whether to enforce strict validation oneOf: - properties: type: enum: - text - json_object - required: - type - json_schema properties: type: enum: - json_schema document_annotation_format: type: object description: >- Format for document-level annotations. Supports text, json_object, and json_schema modes. required: - type properties: type: type: string enum: - text - json_object - json_schema description: The format type json_schema: type: object description: JSON schema definition (required when type is json_schema) properties: schema: type: object description: The JSON schema name: type: string description: Name of the schema strict: type: boolean description: Whether to enforce strict validation oneOf: - properties: type: enum: - text - json_object - required: - type - json_schema properties: type: enum: - json_schema document_annotation_prompt: type: string description: Custom prompt for document annotation AsyncJobResponse: type: object description: Response returned when creating or polling an async job required: - id - status - created_at properties: id: type: string description: Unique identifier for the async job status: $ref: '#/components/schemas/AsyncJobStatus' expires_at: type: string format: date-time description: When the job result expires and will be cleaned up created_at: type: string format: date-time description: When the job was created completed_at: type: string format: date-time description: When the job completed (successfully or with failure) status_code: type: integer description: HTTP status code of the completed operation result: description: >- The result of the completed operation (shape depends on the request type) error: $ref: '#/components/schemas/BifrostError' BifrostError: type: object description: Error response from Bifrost properties: event_id: type: string type: type: string is_bifrost_error: type: boolean status_code: type: integer error: $ref: '#/components/schemas/ErrorField' extra_fields: $ref: '#/components/schemas/BifrostErrorExtraFields' OCRDocument: type: object properties: type: type: string enum: - document_url - image_url description: | Type of document input: - `document_url`: A PDF URL or base64 data URL - `image_url`: An image URL document_url: type: string description: >- URL or base64 data URL of the document (required when type is document_url) image_url: type: string description: URL of the image to process (required when type is image_url) oneOf: - required: - type - document_url properties: type: enum: - document_url - required: - type - image_url properties: type: enum: - image_url AsyncJobStatus: type: string description: The status of an async job enum: - pending - processing - completed - failed ErrorField: type: object properties: type: type: string code: type: string message: type: string param: type: string event_id: type: string BifrostErrorExtraFields: type: object properties: provider: $ref: '#/components/schemas/ModelProvider' model_requested: type: string request_type: type: string ModelProvider: type: string description: AI model provider identifier enum: - openai - azure - anthropic - bedrock - cohere - vertex - vllm - mistral - ollama - groq - sgl - parasail - perplexity - replicate - cerebras - gemini - openrouter - elevenlabs - huggingface - nebius - xai - runway - fireworks securitySchemes: BearerAuth: type: http scheme: bearer description: > Bearer token authentication. Use your provider API key or Bifrost authentication token. Virtual keys (prefixed with `sk-bf-`) can also be passed here. BasicAuth: type: http scheme: basic description: | Basic authentication using username and password. ApiKeyAuth: type: apiKey in: header name: x-api-key description: | API key authentication via the `x-api-key` header. Virtual keys (prefixed with `sk-bf-`) can also be passed here. VirtualKeyAuth: type: apiKey in: header name: x-bf-vk description: > Bifrost Virtual Key for governance, routing, and access control. Supported on all inference endpoints (`/v1/*`, `/openai/*`, `/anthropic/*`, `/bedrock/*`, `/cohere/*`, `/genai/*`, `/langchain/*`, `/litellm/*`, `/pydanticai/*`, `/mcp`), not on management APIs (`/api/*`). Example: `sk-bf-*` prefixed keys. ````