> ## 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 response (LiteLLM - OpenAI Responses API)

> Creates a response using OpenAI Responses API format via LiteLLM.
Supports streaming via SSE.




## OpenAPI

````yaml /openapi/openapi.json post /litellm/v1/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: 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:
  /litellm/v1/responses:
    post:
      tags:
        - LiteLLM Integration
      summary: Create response (LiteLLM - OpenAI Responses API)
      description: |
        Creates a response using OpenAI Responses API format via LiteLLM.
        Supports streaming via SSE.
      operationId: litellmOpenAIResponses
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenAIResponsesRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponsesResponse'
            text/event-stream:
              schema:
                type: object
                description: Streaming responses API response (SSE format)
                properties:
                  type:
                    type: string
                    enum:
                      - response.ping
                      - response.created
                      - response.in_progress
                      - response.completed
                      - response.failed
                      - response.incomplete
                      - response.output_item.added
                      - response.output_item.done
                      - response.content_part.added
                      - response.content_part.done
                      - response.output_text.delta
                      - response.output_text.done
                      - response.refusal.delta
                      - response.refusal.done
                      - response.function_call_arguments.delta
                      - response.function_call_arguments.done
                      - response.file_search_call.in_progress
                      - response.file_search_call.searching
                      - response.file_search_call.results.added
                      - response.file_search_call.results.completed
                      - response.web_search_call.searching
                      - response.web_search_call.results.added
                      - response.web_search_call.results.completed
                      - response.web_fetch_call.in_progress
                      - response.web_fetch_call.fetching
                      - response.web_fetch_call.completed
                      - response.reasoning_summary_part.added
                      - response.reasoning_summary_part.done
                      - response.reasoning_summary_text.delta
                      - response.reasoning_summary_text.done
                      - response.image_generation_call.completed
                      - response.image_generation_call.generating
                      - response.image_generation_call.in_progress
                      - response.image_generation_call.partial_image
                      - response.mcp_call_arguments.delta
                      - response.mcp_call_arguments.done
                      - response.mcp_call.completed
                      - response.mcp_call.failed
                      - response.mcp_call.in_progress
                      - response.mcp_list_tools.completed
                      - response.mcp_list_tools.failed
                      - response.mcp_list_tools.in_progress
                      - response.code_interpreter_call.in_progress
                      - response.code_interpreter_call.interpreting
                      - response.code_interpreter_call.completed
                      - response.code_interpreter_call_code.delta
                      - response.code_interpreter_call_code.done
                      - response.output_text.annotation.added
                      - response.output_text.annotation.done
                      - response.queued
                      - response.custom_tool_call_input.delta
                      - response.custom_tool_call_input.done
                      - error
                  sequence_number:
                    type: integer
                  response:
                    $ref: '#/components/schemas/ResponsesResponse'
                  output_index:
                    type: integer
                  item:
                    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:
                        type: object
                      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
                  content_index:
                    type: integer
                  item_id:
                    type: string
                  part:
                    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'
                  delta:
                    type: string
                  signature:
                    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
                  text:
                    type: string
                  refusal:
                    type: string
                  arguments:
                    type: string
                  partial_image_b64:
                    type: string
                  partial_image_index:
                    type: integer
                  annotation:
                    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
                  annotation_index:
                    type: integer
                  code:
                    type: string
                  message:
                    type: string
                  param:
                    type: string
                  extra_fields:
                    $ref: '#/components/schemas/BifrostResponseExtraFields'
        '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:
  schemas:
    OpenAIResponsesRequest:
      type: object
      required:
        - model
        - input
      properties:
        model:
          type: string
          description: Model identifier
          example: gpt-4
        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:
                    type: object
                  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
        stream:
          type: boolean
        instructions:
          type: string
          description: System instructions for the model
        max_output_tokens:
          type: integer
        metadata:
          type: object
          additionalProperties: true
        parallel_tool_calls:
          type: boolean
        previous_response_id:
          type: string
        reasoning:
          type: object
          properties:
            effort:
              type: string
              enum:
                - none
                - minimal
                - low
                - medium
                - high
                - xhigh
            generate_summary:
              type: string
              enum:
                - auto
                - concise
                - detailed
            summary:
              type: string
              enum:
                - auto
                - concise
                - detailed
            max_tokens:
              type: integer
        store:
          type: boolean
        temperature:
          type: number
          minimum: 0
          maximum: 2
        text:
          type: object
          properties:
            format:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - text
                    - json_object
                    - json_schema
                json_schema:
                  type: object
                  properties:
                    name:
                      type: string
                    schema:
                      type: object
                    strict:
                      type: boolean
        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
        top_p:
          type: number
        truncation:
          type: string
          enum:
            - auto
            - disabled
        user:
          type: string
        fallbacks:
          type: array
          items:
            type: string
    ResponsesResponse:
      type: object
      properties:
        id:
          type: string
        background:
          type: boolean
        conversation:
          type: object
        created_at:
          type: integer
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
        include:
          type: array
          items:
            type: string
        incomplete_details:
          type: object
          required:
            - reason
          properties:
            reason:
              type: string
        instructions:
          type: object
        max_output_tokens:
          type: integer
        max_tool_calls:
          type: integer
        metadata:
          type: object
        model:
          type: string
        output:
          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:
                type: object
              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
        parallel_tool_calls:
          type: boolean
        previous_response_id:
          type: string
        prompt:
          type: object
        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
        status:
          type: string
          enum:
            - completed
            - failed
            - in_progress
            - canceled
            - queued
            - incomplete
        stop_reason:
          type: string
        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
        usage:
          type: object
          properties:
            input_tokens:
              type: integer
            input_tokens_details:
              type: object
              properties:
                text_tokens:
                  type: integer
                audio_tokens:
                  type: integer
                image_tokens:
                  type: integer
                cached_read_tokens:
                  type: integer
                  description: >
                    Tokens served from the prompt cache (cache hit), billed at
                    the reduced cache-read rate. Already included in the parent
                    input_tokens total.
                cached_write_tokens:
                  type: integer
                  description: >
                    Tokens written to the prompt cache on this request, billed
                    at the cache-creation rate. Already included in the parent
                    input_tokens total. Populated for providers that separately
                    report cache write tokens (Anthropic, Bedrock).
            output_tokens:
              type: integer
            output_tokens_details:
              type: object
              properties:
                text_tokens:
                  type: integer
                accepted_prediction_tokens:
                  type: integer
                audio_tokens:
                  type: integer
                reasoning_tokens:
                  type: integer
                rejected_prediction_tokens:
                  type: integer
                citation_tokens:
                  type: integer
                num_search_queries:
                  type: integer
            total_tokens:
              type: integer
            cost:
              $ref: '#/components/schemas/BifrostCost'
        extra_fields:
          $ref: '#/components/schemas/BifrostResponseExtraFields'
        search_results:
          type: array
          items:
            $ref: '#/components/schemas/PerplexitySearchResult'
        videos:
          type: array
          items:
            $ref: '#/components/schemas/PerplexityVideoResult'
        citations:
          type: array
          items:
            type: string
    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")
    BifrostResponseExtraFields:
      type: object
      description: Additional fields included in responses
      properties:
        request_type:
          type: string
          description: Type of request that was made
        provider:
          $ref: '#/components/schemas/ModelProvider'
        model_requested:
          type: string
          description: The model that was requested
        model_deployment:
          type: string
          description: The actual model deployment used
        latency:
          type: integer
          format: int64
          description: Request latency in milliseconds
        chunk_index:
          type: integer
          description: Index of the chunk for streaming responses
        raw_request:
          type: object
          description: Raw request if enabled
        raw_response:
          type: object
          description: Raw response if enabled
        cache_debug:
          $ref: '#/components/schemas/BifrostCacheDebug'
    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'
    BifrostCost:
      type: object
      description: Cost breakdown for the request
      properties:
        input_tokens_cost:
          type: number
        output_tokens_cost:
          type: number
        reasoning_tokens_cost:
          type: number
          description: Cost for reasoning/thinking tokens (reasoning models)
        citation_tokens_cost:
          type: number
          description: Cost for citation tokens
        search_queries_cost:
          type: number
          description: Cost for web search queries
        request_cost:
          type: number
        total_cost:
          type: number
    PerplexitySearchResult:
      type: object
      description: Search result from Perplexity AI search
      properties:
        title:
          type: string
        url:
          type: string
        date:
          type: string
        last_updated:
          type: string
        snippet:
          type: string
        source:
          type: string
    PerplexityVideoResult:
      type: object
      properties:
        url:
          type: string
        thumbnail_url:
          type: string
        thumbnail_width:
          type: integer
        thumbnail_height:
          type: integer
        duration:
          type: number
    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
    BifrostCacheDebug:
      type: object
      properties:
        cache_hit:
          type: boolean
        cache_id:
          type: string
        hit_type:
          type: string
        requested_provider:
          type: string
        requested_model:
          type: string
        provider_used:
          type: string
        model_used:
          type: string
        input_tokens:
          type: integer
        threshold:
          type: number
        similarity:
          type: number
    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
  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.

````