> ## Documentation Index > Fetch the complete documentation index at: https://bifrost-dev.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Create async response > Submits a response 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. Streaming is not supported for async requests. ## OpenAPI ````yaml /openapi/openapi.json post /v1/async/responses 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: Realtime description: Realtime WebSocket and WebRTC 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: Routing description: Routing rules and complexity analyzer configuration - name: Logging description: Log search and management endpoints - name: Cache description: Cache management endpoints - name: Vault description: Vault secret management endpoints - name: Skills description: Skills Repository management, marketplace, and download endpoints - name: Audit Logs description: >- CADF-compliant audit log search, export, and signature verification endpoints - name: Webhooks description: Webhook endpoint management and signed async-job delivery history - name: Notifications description: >- Role-targeted dashboard notifications, delivered over the dashboard WebSocket paths: /v1/async/responses: post: tags: - Async Jobs summary: Create async response description: > Submits a response 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. Streaming is not supported for async requests. operationId: createAsyncResponse parameters: - $ref: '#/components/parameters/AsyncResultTTL' - $ref: '#/components/parameters/AsyncWebhookEndpoint' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ResponsesRequest' 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 AsyncWebhookEndpoint: name: x-bf-async-webhook in: header required: false description: > Name of a registered webhook endpoint to notify when this job reaches a terminal state (`completed` or `failed`). The endpoint must already exist and be enabled; otherwise the submission is rejected with HTTP 400. If the endpoint is not subscribed to the resulting event, the job still completes normally but no delivery is enqueued. When omitted, no webhook is sent for the job and results are retrieved by polling. See the Webhooks management API to register endpoints. schema: type: string schemas: ResponsesRequest: type: object required: - model - input properties: model: type: string description: Model in provider/model format input: oneOf: - type: string - type: array items: type: object properties: id: type: string type: type: string enum: - message - file_search_call - computer_call - computer_call_output - web_search_call - web_fetch_call - function_call - function_call_output - code_interpreter_call - local_shell_call - local_shell_call_output - mcp_call - custom_tool_call - custom_tool_call_output - image_generation_call - mcp_list_tools - mcp_approval_request - mcp_approval_responses - reasoning - item_reference - refusal status: type: string enum: - in_progress - completed - incomplete - interpreting - failed role: type: string enum: - assistant - user - system - developer content: oneOf: - type: string - type: array items: type: object required: - type properties: type: type: string enum: - input_text - input_image - input_file - input_audio - output_text - refusal - reasoning_text file_id: type: string text: type: string signature: type: string image_url: type: string detail: type: string file_data: type: string file_url: type: string filename: type: string file_type: type: string input_audio: type: object required: - format - data properties: format: type: string enum: - mp3 - wav data: type: string annotations: type: array items: type: object properties: type: type: string enum: - file_citation - url_citation - container_file_citation - file_path index: type: integer file_id: type: string text: type: string start_index: type: integer end_index: type: integer filename: type: string title: type: string url: type: string container_id: type: string logprobs: type: array items: type: object properties: bytes: type: array items: type: integer logprob: type: number token: type: string top_logprobs: type: array items: type: object properties: bytes: type: array items: type: integer logprob: type: number token: type: string refusal: type: string cache_control: $ref: '#/components/schemas/CacheControl' call_id: type: string name: type: string arguments: type: string output: description: > Tool call output. A plain string for function/custom/local-shell tool outputs, an array of content blocks for structured function tool outputs, or a computer-tool screenshot object for computer_call_output. oneOf: - type: string - type: array items: type: object required: - type properties: type: type: string enum: - input_text - input_image - input_file - input_audio - output_text - refusal - reasoning_text file_id: type: string text: type: string signature: type: string image_url: type: string detail: type: string file_data: type: string file_url: type: string filename: type: string file_type: type: string input_audio: type: object required: - format - data properties: format: type: string enum: - mp3 - wav data: type: string annotations: type: array items: type: object properties: type: type: string enum: - file_citation - url_citation - container_file_citation - file_path index: type: integer file_id: type: string text: type: string start_index: type: integer end_index: type: integer filename: type: string title: type: string url: type: string container_id: type: string logprobs: type: array items: type: object properties: bytes: type: array items: type: integer logprob: type: number token: type: string top_logprobs: type: array items: type: object properties: bytes: type: array items: type: integer logprob: type: number token: type: string refusal: type: string cache_control: $ref: '#/components/schemas/CacheControl' - type: object description: Computer tool call output (computer_screenshot). properties: type: type: string enum: - computer_screenshot file_id: type: string image_url: type: string action: type: object error: type: string queries: type: array items: type: string results: type: array items: type: object summary: type: array items: type: object required: - type - text properties: type: type: string enum: - summary_text text: type: string encrypted_content: type: string description: Input - can be a string or array of messages fallbacks: type: array items: type: string stream: type: boolean background: type: boolean conversation: type: string context_management: $ref: '#/components/schemas/ContextManagement' include: type: array items: type: string instructions: type: string max_output_tokens: type: integer max_tool_calls: type: integer metadata: type: object additionalProperties: true parallel_tool_calls: type: boolean previous_response_id: type: string prompt_cache_key: type: string reasoning: type: object properties: effort: type: string enum: - none - minimal - low - medium - high - xhigh generate_summary: type: string deprecated: true summary: type: string enum: - auto - concise - detailed max_tokens: type: integer safety_identifier: type: string service_tier: type: string stream_options: type: object properties: include_obfuscation: type: boolean store: type: boolean temperature: type: number text: type: object properties: format: type: object required: - type properties: type: type: string enum: - text - json_schema - json_object name: type: string schema: type: object strict: type: boolean verbosity: type: string enum: - low - medium - high top_logprobs: type: integer top_p: type: number tool_choice: oneOf: - type: string enum: - none - auto - required - type: object required: - type properties: type: type: string enum: - none - auto - any - required - function - allowed_tools - file_search - web_search_preview - computer_use_preview - code_interpreter - image_generation - mcp - custom mode: type: string name: type: string server_label: type: string tools: type: array items: type: object required: - type properties: type: type: string enum: - function - mcp - image_generation name: type: string server_label: type: string tools: type: array items: type: object required: - type properties: type: type: string enum: - function - file_search - computer_use_preview - web_search - web_fetch - mcp - code_interpreter - image_generation - local_shell - custom - web_search_preview - memory - tool_search name: type: string description: type: string cache_control: $ref: '#/components/schemas/CacheControl' parameters: type: object properties: type: type: string description: type: string required: type: array items: type: string properties: type: object additionalProperties: true enum: type: array items: type: string additionalProperties: type: boolean strict: type: boolean vector_store_ids: type: array items: type: string filters: type: object max_num_results: type: integer ranking_options: type: object display_height: type: integer display_width: type: integer environment: type: string enable_zoom: type: boolean search_context_size: type: string user_location: type: object server_label: type: string server_url: type: string allowed_tools: type: object authorization: type: string connector_id: type: string headers: type: object additionalProperties: type: string require_approval: type: object server_description: type: string container: type: object background: type: string input_fidelity: type: string input_image_mask: type: object moderation: type: string output_compression: type: integer output_format: type: string partial_images: type: integer quality: type: string size: type: string format: type: object truncation: type: string 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' CacheControl: type: object description: Cache control settings for content blocks properties: type: type: string enum: - ephemeral ttl: type: string description: Time to live (e.g., "1m", "1h") ContextManagement: description: > Automatic context window management. The wire shape depends on the target provider: OpenAI-compatible providers accept an array of {type, compact_threshold} entries; Anthropic-compatible providers accept an object with an "edits" array (compact_20260112, clear_tool_uses_20250919, clear_thinking_20251015). oneOf: - type: array description: OpenAI native shape — an array of context-management entries. items: type: object properties: type: type: string description: Entry type. Currently only "compaction" is supported. compact_threshold: type: integer description: >- Token threshold at which compaction should be triggered for this entry. additionalProperties: true - type: object description: Anthropic native shape — an object with an "edits" array. properties: edits: type: array items: type: object additionalProperties: true additionalProperties: true 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 - deepseek - 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. ````