> ## 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.

# Stream converse with model (PydanticAI - Bedrock format)

> Streams messages using AWS Bedrock Converse-compatible format via PydanticAI.




## OpenAPI

````yaml /openapi/openapi.json post /pydanticai/bedrock/model/{modelId}/converse-stream
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:
  /pydanticai/bedrock/model/{modelId}/converse-stream:
    post:
      tags:
        - PydanticAI Integration
      summary: Stream converse with model (PydanticAI - Bedrock format)
      description: >
        Streams messages using AWS Bedrock Converse-compatible format via
        PydanticAI.
      operationId: pydanticaiBedrockConverseStream
      parameters:
        - name: modelId
          in: path
          required: true
          schema:
            type: string
          description: Model ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BedrockConverseRequest'
      responses:
        '200':
          description: Successful streaming response
          content:
            application/x-amz-eventstream:
              schema:
                type: object
                description: >-
                  Flat structure for streaming events matching actual Bedrock
                  API response
                properties:
                  role:
                    type: string
                    description: For messageStart events
                  contentBlockIndex:
                    type: integer
                    description: For content block events
                  delta:
                    type: object
                    properties:
                      text:
                        type: string
                      reasoningContent:
                        type: object
                        properties:
                          text:
                            type: string
                          signature:
                            type: string
                      toolUse:
                        type: object
                        properties:
                          input:
                            type: string
                  stopReason:
                    type: string
                    description: For messageStop events
                  start:
                    type: object
                    properties:
                      toolUse:
                        type: object
                        properties:
                          toolUseId:
                            type: string
                          name:
                            type: string
                  usage:
                    type: object
                    properties:
                      inputTokens:
                        type: integer
                      outputTokens:
                        type: integer
                      totalTokens:
                        type: integer
                      cacheReadInputTokens:
                        type: integer
                      cacheWriteInputTokens:
                        type: integer
                  metrics:
                    type: object
                    properties:
                      latencyMs:
                        type: integer
                  trace:
                    type: object
                  additionalModelResponseFields:
                    type: object
                  invokeModelRawChunk:
                    type: string
                    format: byte
                    description: Raw bytes for legacy invoke stream
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockError'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BedrockError'
      security:
        - BearerAuth: []
        - BasicAuth: []
        - VirtualKeyAuth: []
        - ApiKeyAuth: []
components:
  schemas:
    BedrockConverseRequest:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: '#/components/schemas/BedrockMessage'
          description: Array of messages for the conversation
        system:
          type: array
          items:
            type: object
            properties:
              text:
                type: string
              guardContent:
                type: object
                properties:
                  text:
                    type: object
                    properties:
                      text:
                        type: string
                      qualifiers:
                        type: array
                        items:
                          type: string
              cachePoint:
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - default
          description: System messages/prompts
        inferenceConfig:
          type: object
          properties:
            maxTokens:
              type: integer
            temperature:
              type: number
            topP:
              type: number
            stopSequences:
              type: array
              items:
                type: string
        toolConfig:
          type: object
          properties:
            tools:
              type: array
              items:
                type: object
                properties:
                  toolSpec:
                    type: object
                    properties:
                      name:
                        type: string
                      description:
                        type: string
                      inputSchema:
                        type: object
                        properties:
                          json:
                            type: object
                  cachePoint:
                    type: object
                    properties:
                      type:
                        type: string
                        enum:
                          - default
            toolChoice:
              type: object
              properties:
                auto:
                  type: object
                any:
                  type: object
                tool:
                  type: object
                  properties:
                    name:
                      type: string
        guardrailConfig:
          type: object
          properties:
            guardrailIdentifier:
              type: string
            guardrailVersion:
              type: string
            trace:
              type: string
              enum:
                - enabled
                - disabled
        additionalModelRequestFields:
          type: object
          description: Model-specific parameters
        additionalModelResponseFieldPaths:
          type: array
          items:
            type: string
        performanceConfig:
          type: object
          properties:
            latency:
              type: string
              enum:
                - standard
                - optimized
        promptVariables:
          type: object
          additionalProperties:
            type: object
            properties:
              text:
                type: string
        requestMetadata:
          type: object
          additionalProperties:
            type: string
        serviceTier:
          type: object
          properties:
            type:
              type: string
              enum:
                - reserved
                - priority
                - default
                - flex
        fallbacks:
          type: array
          items:
            type: string
    BedrockError:
      type: object
      properties:
        message:
          type: string
        type:
          type: string
    BedrockMessage:
      type: object
      required:
        - role
        - content
      properties:
        role:
          type: string
          enum:
            - user
            - assistant
        content:
          type: array
          items:
            $ref: '#/components/schemas/BedrockContentBlock'
    BedrockContentBlock:
      type: object
      properties:
        text:
          type: string
        image:
          type: object
          properties:
            format:
              type: string
              enum:
                - jpeg
                - png
                - gif
                - webp
            source:
              type: object
              properties:
                bytes:
                  type: string
                  format: byte
        document:
          type: object
          properties:
            format:
              type: string
              enum:
                - pdf
                - csv
                - doc
                - docx
                - xls
                - xlsx
                - html
                - txt
                - md
            name:
              type: string
            source:
              type: object
              properties:
                bytes:
                  type: string
                  format: byte
                text:
                  type: string
                  description: Plain text content (for text-based documents)
        toolUse:
          type: object
          properties:
            toolUseId:
              type: string
            name:
              type: string
            input:
              type: object
        toolResult:
          type: object
          properties:
            toolUseId:
              type: string
            content:
              type: array
              items:
                $ref: '#/components/schemas/BedrockContentBlock'
            status:
              type: string
              enum:
                - success
                - error
        guardContent:
          type: object
          properties:
            text:
              type: object
              properties:
                text:
                  type: string
                qualifiers:
                  type: array
                  items:
                    type: string
        reasoningContent:
          type: object
          properties:
            reasoningText:
              type: object
              properties:
                text:
                  type: string
                signature:
                  type: string
        json:
          type: object
          description: JSON content for tool call results
        cachePoint:
          type: object
          properties:
            type:
              type: string
              enum:
                - default
  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.

````