> ## Documentation Index
> Fetch the complete documentation index at: https://gproxy.leenhawk.com/llms.txt
> Use this file to discover all available pages before exploring further.

# POST /v1/live

> Available at the instance root or under a provider/namespace prefix. Shared paths select the wire dialect from client headers; without dialect evidence, the first listed route wins.



## OpenAPI

````yaml /generated/openapi.json post /v1/live
openapi: 3.1.0
info:
  description: >-
    Forwarding, management, portal and OAuth APIs generated from Rust types.
    Input and output schemas preserve their respective Serde contracts.
    Streaming events and WebSocket messages are documented alongside HTTP
    payloads.
  title: GPROXY HTTP API
  version: 4.2.1
servers: []
security:
  - bearer: []
  - anthropicKey: []
  - googleKey: []
  - queryKey: []
paths:
  /v1/live:
    post:
      tags:
        - Forwarding
      summary: POST /v1/live
      description: >-
        Available at the instance root or under a provider/namespace prefix.
        Shared paths select the wire dialect from client headers; without
        dialect evidence, the first listed route wins.
      parameters: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Input_CreateLiveCallMultipartForm'
        required: true
      responses:
        2XX:
          content:
            application/sdp:
              schema:
                type: string
          description: Successful protocol response
        default:
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/Output_Envelope'
                  - properties:
                      error:
                        $ref: '#/components/schemas/Output_ErrorDetail'
                    required:
                      - error
                    type: object
                  - allOf:
                      - $ref: '#/components/schemas/Output_ErrorEvent'
                      - properties:
                          type:
                            const: error
                        required:
                          - type
                        type: object
                  - properties:
                      error:
                        $ref: '#/components/schemas/Output_GenerateContentError'
                    required:
                      - error
                    type: object
            text/plain:
              schema:
                type: string
          description: Gateway or upstream error
components:
  schemas:
    Input_CreateLiveCallMultipartForm:
      properties:
        sdp:
          $ref: '#/components/schemas/Input_BinaryPart'
        session:
          $ref: '#/components/schemas/Input_LiveSessionCreateRequest'
      required:
        - sdp
        - session
      type: object
    Output_Envelope:
      properties:
        error:
          $ref: '#/components/schemas/Output_EnvelopeBody'
      required:
        - error
      type: object
    Output_ErrorDetail:
      properties:
        code:
          type:
            - string
            - 'null'
        message:
          type: string
        param:
          type:
            - string
            - 'null'
        type:
          type:
            - string
            - 'null'
      required:
        - message
      type: object
    Output_ErrorEvent:
      additionalProperties: true
      properties:
        error:
          $ref: '#/components/schemas/Output_StreamError'
        request_id:
          type:
            - string
            - 'null'
      required:
        - error
      type: object
    Output_GenerateContentError:
      additionalProperties: true
      properties:
        code:
          format: int64
          type: integer
        details:
          items: true
          type:
            - array
            - 'null'
        message:
          type: string
        status:
          type:
            - string
            - 'null'
      required:
        - code
        - message
      type: object
    Input_BinaryPart:
      format: binary
      type: string
    Input_LiveSessionCreateRequest:
      additionalProperties: true
      description: |-
        Frameless WebRTC setup at `POST /v1/live`. Unlike Realtime, this session
        has no required `type: realtime`.
      properties:
        audio:
          anyOf:
            - $ref: '#/components/schemas/Input_RealtimeAudioConfig'
            - type: 'null'
        delegation:
          anyOf:
            - $ref: '#/components/schemas/Input_LiveDelegation2'
            - type: 'null'
        initial_items:
          items:
            $ref: '#/components/schemas/Input_LiveInitialMessage'
          type:
            - array
            - 'null'
        instructions:
          type:
            - string
            - 'null'
        model:
          type:
            - string
            - 'null'
      type: object
    Output_EnvelopeBody:
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      type: object
    Output_StreamError:
      additionalProperties: true
      properties:
        message:
          type: string
        type:
          $ref: '#/components/schemas/Output_StreamErrorType'
      required:
        - type
        - message
      type: object
    Input_RealtimeAudioConfig:
      additionalProperties: true
      properties:
        input:
          anyOf:
            - $ref: '#/components/schemas/Input_RealtimeAudioConfigInput'
            - type: 'null'
        output:
          anyOf:
            - $ref: '#/components/schemas/Input_RealtimeAudioConfigOutput'
            - type: 'null'
      type: object
    Input_LiveDelegation2:
      additionalProperties: true
      properties:
        ack_filler:
          type:
            - boolean
            - 'null'
        type:
          type: string
      required:
        - type
      type: object
    Input_LiveInitialMessage:
      additionalProperties: true
      properties:
        content:
          items:
            $ref: '#/components/schemas/Input_LiveInitialText'
          type: array
        role:
          type: string
        type:
          type: string
      required:
        - type
        - role
        - content
      type: object
    Output_StreamErrorType:
      enum:
        - api_error
        - authentication_error
        - billing_error
        - invalid_request_error
        - not_found_error
        - overloaded_error
        - permission_error
        - rate_limit_error
        - timeout_error
        - conflict_error
        - request_too_large
      type: string
    Input_RealtimeAudioConfigInput:
      additionalProperties: true
      properties:
        format:
          anyOf:
            - $ref: '#/components/schemas/Input_RealtimeAudioFormats'
            - type: 'null'
        noise_reduction:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_RealtimeAudioConfigInputNoiseReduction
            - type: 'null'
        transcription:
          anyOf:
            - $ref: '#/components/schemas/Input_AudioTranscription2'
            - type: 'null'
        turn_detection:
          anyOf:
            - $ref: '#/components/schemas/Input_RealtimeAudioInputTurnDetection'
            - type: 'null'
      type: object
    Input_RealtimeAudioConfigOutput:
      additionalProperties: true
      properties:
        format:
          anyOf:
            - $ref: '#/components/schemas/Input_RealtimeAudioFormats'
            - type: 'null'
        speed:
          type:
            - number
            - 'null'
        voice:
          anyOf:
            - $ref: '#/components/schemas/Input_RealtimeAudioConfigOutputVoice'
            - type: 'null'
      type: object
    Input_LiveInitialText:
      additionalProperties: true
      properties:
        text:
          type: string
        type:
          type: string
      required:
        - type
        - text
      type: object
    Input_RealtimeAudioFormats:
      anyOf:
        - $ref: '#/components/schemas/Input_RealtimeAudioFormatsAudioPCM'
        - $ref: '#/components/schemas/Input_RealtimeAudioFormatsAudioPCMU'
        - $ref: '#/components/schemas/Input_RealtimeAudioFormatsAudioPCMA'
    Input_RealtimeAudioConfigInputNoiseReduction:
      additionalProperties: true
      properties:
        type:
          anyOf:
            - $ref: '#/components/schemas/Input_NoiseReductionType'
            - type: 'null'
      type: object
    Input_AudioTranscription2:
      additionalProperties: true
      properties:
        delay:
          anyOf:
            - $ref: '#/components/schemas/Input_AudioTranscriptionDelay'
            - type: 'null'
        keywords:
          items:
            type: string
          type:
            - array
            - 'null'
        language:
          type:
            - string
            - 'null'
        languages:
          items:
            type: string
          type:
            - array
            - 'null'
        model:
          type:
            - string
            - 'null'
        prompt:
          type:
            - string
            - 'null'
      type: object
    Input_RealtimeAudioInputTurnDetection:
      anyOf:
        - $ref: '#/components/schemas/Input_RealtimeAudioInputTurnDetectionServerVad'
        - $ref: >-
            #/components/schemas/Input_RealtimeAudioInputTurnDetectionSemanticVad
        - type: 'null'
    Input_RealtimeAudioConfigOutputVoice:
      anyOf:
        - type: string
        - $ref: '#/components/schemas/Input_RealtimeAudioConfigOutputVoiceID'
    Input_RealtimeAudioFormatsAudioPCM:
      additionalProperties: true
      properties:
        rate:
          anyOf:
            - $ref: '#/components/schemas/Input_RealtimeAudioFormatsAudioPCMRate'
            - type: 'null'
        type:
          anyOf:
            - $ref: '#/components/schemas/Input_RealtimeAudioFormatsAudioPCMType'
            - type: 'null'
      type: object
    Input_RealtimeAudioFormatsAudioPCMU:
      additionalProperties: true
      properties:
        type:
          anyOf:
            - $ref: '#/components/schemas/Input_RealtimeAudioFormatsAudioPCMUType'
            - type: 'null'
      type: object
    Input_RealtimeAudioFormatsAudioPCMA:
      additionalProperties: true
      properties:
        type:
          anyOf:
            - $ref: '#/components/schemas/Input_RealtimeAudioFormatsAudioPCMAType'
            - type: 'null'
      type: object
    Input_NoiseReductionType:
      enum:
        - near_field
        - far_field
      type: string
    Input_AudioTranscriptionDelay:
      enum:
        - minimal
        - low
        - medium
        - high
        - xhigh
      type: string
    Input_RealtimeAudioInputTurnDetectionServerVad:
      additionalProperties: true
      properties:
        create_response:
          type:
            - boolean
            - 'null'
        idle_timeout_ms:
          format: int64
          type:
            - integer
            - 'null'
        interrupt_response:
          type:
            - boolean
            - 'null'
        prefix_padding_ms:
          format: int64
          type:
            - integer
            - 'null'
        silence_duration_ms:
          format: int64
          type:
            - integer
            - 'null'
        threshold:
          type:
            - number
            - 'null'
        type:
          $ref: >-
            #/components/schemas/Input_RealtimeAudioInputTurnDetectionServerVadType
      required:
        - type
      type: object
    Input_RealtimeAudioInputTurnDetectionSemanticVad:
      additionalProperties: true
      properties:
        create_response:
          type:
            - boolean
            - 'null'
        eagerness:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_RealtimeAudioInputTurnDetectionSemanticVadEagerness
            - type: 'null'
        interrupt_response:
          type:
            - boolean
            - 'null'
        type:
          $ref: >-
            #/components/schemas/Input_RealtimeAudioInputTurnDetectionSemanticVadType
      required:
        - type
      type: object
    Input_RealtimeAudioConfigOutputVoiceID:
      additionalProperties: true
      properties:
        id:
          type: string
      required:
        - id
      type: object
    Input_RealtimeAudioFormatsAudioPCMRate:
      description: >-
        A numeric literal validated through scalar conversion; object routing
        remains derived.
      format: int64
      type: integer
    Input_RealtimeAudioFormatsAudioPCMType:
      enum:
        - audio/pcm
      type: string
    Input_RealtimeAudioFormatsAudioPCMUType:
      enum:
        - audio/pcmu
      type: string
    Input_RealtimeAudioFormatsAudioPCMAType:
      enum:
        - audio/pcma
      type: string
    Input_RealtimeAudioInputTurnDetectionServerVadType:
      enum:
        - server_vad
      type: string
    Input_RealtimeAudioInputTurnDetectionSemanticVadEagerness:
      enum:
        - low
        - medium
        - high
        - auto
      type: string
    Input_RealtimeAudioInputTurnDetectionSemanticVadType:
      enum:
        - semantic_vad
      type: string
  securitySchemes:
    bearer:
      scheme: bearer
      type: http
    anthropicKey:
      in: header
      name: x-api-key
      type: apiKey
    googleKey:
      in: header
      name: x-goog-api-key
      type: apiKey
    queryKey:
      in: query
      name: key
      type: apiKey

````

## Related topics

- [POST /v1/live/sessions](https://gproxy.leenhawk.com/api-reference/forwarding/post-v1livesessions.md)
- [POST /v1/live/sessions/{session_id}/hangup](https://gproxy.leenhawk.com/api-reference/forwarding/post-v1livesessions-hangup.md)
- [Routing & Endpoints](https://gproxy.leenhawk.com/reference/routing-table.md)
- [GET /v1/live](https://gproxy.leenhawk.com/api-reference/forwarding/get-v1live.md)
- [GET /v1/live/sessions](https://gproxy.leenhawk.com/api-reference/forwarding/get-v1livesessions.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.