# Sessions

## Accept call

`live.sessions.accept(session_id, **kwargs) -> void`

**post** `/live/sessions/{session_id}/accept`

Accept an incoming SIP call. Supply session with type live, the model, and startup configuration. Before accepting calls, follow the [Live prompting guide](/api/docs/guides/live-prompting) to write frontend conversation instructions and a separate backend prompt. SIP media format is negotiated; omit audio.format.

### Parameters

- `session_id: String`

- `session: Session{ model, type, audio, 4 more}`

  Model and startup configuration for the Live session that answers the incoming SIP call.

  - `model: String | :"gpt-live-1"`

    The Live model to use for the accepted call.

    - `String = String`

    - `Model = :"gpt-live-1"`

      The Live model. Required in the session configuration for every transport; do not pass it as a URL query parameter.

      - `:"gpt-live-1"`

  - `type: :live`

    The session type. Always `live`.

    - `:live`

  - `audio: Audio{ output}`

    Startup audio output configuration. SIP negotiates the media format; audio.format is only accepted for primary WebSockets. Voice cannot change after startup.

    - `output: Output{ voice}`

      Settings for speech generated by the Live model. Choose the voice before starting the session.

      - `voice: String | BuiltInVoice | CustomVoice`

        The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.

        - `String = String`

        - `BuiltInVoice = :alloy | :ash | :ballad | 19 more`

          A built-in voice available for Live speech.

          - `:alloy`

          - `:ash`

          - `:ballad`

          - `:beacon`

          - `:bossa`

          - `:cedar`

          - `:cinder`

          - `:coral`

          - `:delta`

          - `:echo`

          - `:gleam`

          - `:marin`

          - `:meridian`

          - `:quartz`

          - `:ripple`

          - `:sage`

          - `:shimmer`

          - `:stone`

          - `:tempo`

          - `:verse`

          - `:vesper`

          - `:willow`

        - `class CustomVoice`

          - `id: String`

  - `delegation: ClientDelegation | Responses{ responses, type}`

    Who handles tasks delegated by the Live model. Omitted or null selects your application; use `responses` to let the API manage a Responses backend.

    - `class ClientDelegation`

      Delegate tasks to your application. The Live session emits delegation events that your backend handles.

      - `type: :client`

        The delegation owner. Always `client` for tasks handled by your application.

        - `:client`

    - `class Responses`

      Delegate tasks to a Responses model managed by the Live session.

      - `responses: ResponsesDelegationConfig`

        Backend model, prompt, and tools used when the Live session delegates a task to Responses.

        - `model: String`

          The model used for server-owned Responses delegations.

        - `instructions: String`

          Instructions for the delegated Responses model, separate from Live instructions. See [backend prompting](/api/docs/guides/live-delegation#start-with-your-existing-backend-prompt).

        - `max_output_tokens: Integer`

          Maximum number of output tokens for each delegated response.

        - `parallel_tool_calls: bool`

          Whether the delegated Responses model may request multiple tool calls in a single response.

        - `reasoning: Reasoning{ effort, summary}`

          Reasoning settings passed to each delegated Responses request.

          - `effort: :none | :minimal | :low | 3 more`

            How much reasoning effort the delegated Responses model should use. Supported values depend on the backend model.

            - `:none`

            - `:minimal`

            - `:low`

            - `:medium`

            - `:high`

            - `:xhigh`

          - `summary: :concise | :detailed | :auto`

            The reasoning summary to request from the delegated Responses model, when supported.

            - `:concise`

            - `:detailed`

            - `:auto`

        - `service_tier: :auto | :default | :fast_tier_temp_pilot | 3 more`

          Service tier for delegated Responses requests.

          - `:auto`

          - `:default`

          - `:fast_tier_temp_pilot`

          - `:flex`

          - `:priority`

          - `:ultrafast`

        - `text: Text{ verbosity}`

          Text generation settings passed to each delegated Responses request.

          - `verbosity: :low | :medium | :high`

            The amount of detail in text generated by the Responses backend. This does not configure the Live model’s spoken delivery.

            - `:low`

            - `:medium`

            - `:high`

        - `tool_choice: :auto | :none | :required | LiveFunctionToolChoiceParam{ name, type} | LiveMCPToolChoiceParam{ name, server_label, type}`

          Controls which tool the Responses backend uses when handling a task delegated by the Live model.

          - `LiveToolChoiceEnum = :auto | :none | :required`

            - `:auto`

            - `:none`

            - `:required`

          - `class LiveFunctionToolChoiceParam`

            - `name: String`

            - `type: :function`

              - `:function`

          - `class LiveMCPToolChoiceParam`

            - `name: String`

            - `server_label: String`

            - `type: :mcp`

              - `:mcp`

        - `tools: Array[FunctionTool | WebSearch{ type}]`

          Tools available to the Responses backend while it handles tasks delegated by the Live model.

          - `class FunctionTool`

            A function tool available to the Responses backend when the Live model delegates a task.

            - `name: String`

              The name the delegated Responses model uses when calling this function.

            - `type: :function`

              The tool type. Always `function`.

              - `:function`

            - `description: String`

              What the function does and when the delegated Responses model should call it.

            - `parameters: Hash[Symbol, untyped]`

              A JSON Schema object describing the arguments accepted by the function.

            - `strict: bool`

              Whether the delegated Responses model must follow the function’s parameter schema exactly.

          - `class WebSearch`

            A web search tool available to the Live session’s Responses backend.

            - `type: :web_search`

              The tool type. Always `web_search`.

              - `:web_search`

      - `type: :responses`

        The delegation owner. Always `responses` for tasks handled by the Responses API.

        - `:responses`

  - `input: Array[InitialItem]`

    Ordered text-only history supplied before startup. Supports developer, user, and assistant messages with one text part each; at most 128 messages and 8,192 rendered tokens in total.

    - `class Developer`

      A developer message included in the initial text history of a Live session.

      - `content: Array[Content{ text, type}]`

        The message content. Supply exactly one text part for the initial Live conversation history.

        - `text: String`

          The message text to include in the Live session’s initial conversation history.

        - `type: :input_text`

          The text content type. Always `input_text`.

          - `:input_text`

      - `role: :developer`

        The author of this history message. Always `developer`.

        - `:developer`

      - `id: String`

        An optional identifier for the supplied history message. Live uses the message’s role and text to initialize the conversation.

      - `status: :incomplete | :completed`

        The supplied message’s status. Live uses its text as history and does not resume an incomplete message.

        - `:incomplete`

        - `:completed`

      - `type: :message`

        The history item type. Always `message`.

        - `:message`

    - `class User`

      A user message included in the initial text history of a Live session.

      - `content: Array[Content{ text, type}]`

        The message content. Supply exactly one text part for the initial Live conversation history.

        - `text: String`

          The message text to include in the Live session’s initial conversation history.

        - `type: :input_text`

          The text content type. Always `input_text`.

          - `:input_text`

      - `role: :user`

        The author of this history message. Always `user`.

        - `:user`

      - `id: String`

        An optional identifier for the supplied history message. Live uses the message’s role and text to initialize the conversation.

      - `status: :incomplete | :completed`

        The supplied message’s status. Live uses its text as history and does not resume an incomplete message.

        - `:incomplete`

        - `:completed`

      - `type: :message`

        The history item type. Always `message`.

        - `:message`

    - `class Assistant`

      An assistant message included in the initial text history of a Live session.

      - `content: Array[Text{ text, type} | OutputText{ text, type}]`

        The message content. Supply exactly one text part for the initial Live conversation history.

        - `class Text`

          Assistant text supplied as conversation history when starting a Live session.

          - `text: String`

            The message text to include in the Live session’s initial conversation history.

          - `type: :text`

            The text content type. Always `text`.

            - `:text`

        - `class OutputText`

          Assistant output text supplied as conversation history when starting a Live session.

          - `text: String`

            The message text to include in the Live session’s initial conversation history.

          - `type: :output_text`

            The text content type. Always `output_text`.

            - `:output_text`

      - `role: :assistant`

        The author of this history message. Always `assistant`.

        - `:assistant`

      - `id: String`

        An optional identifier for the supplied history message. Live uses the message’s role and text to initialize the conversation.

      - `status: :incomplete | :completed`

        The supplied message’s status. Live uses its text as history and does not resume an incomplete message.

        - `:incomplete`

        - `:completed`

      - `type: :message`

        The history item type. Always `message`.

        - `:message`

  - `instructions: String`

    Frontend instructions for voice, conversation, interruptions, and when to delegate. Start with the [Live prompting guide](/api/docs/guides/live-prompting); put business rules and tool workflows in a separate [backend prompt](/api/docs/guides/live-delegation#start-with-your-existing-backend-prompt). Limited to 16,384 client-supplied tokens. Omitted or blank instructions use server defaults. Immutable after startup.

  - `store: bool`

    Whether to store the session for later forking and recording download. Defaults to false for new sessions.

### Example

```ruby
require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

result = openai.live.sessions.accept("session_id", session: {model: "gpt-live-1", type: :live})

puts(result)
```

## Download recording

`live.sessions.download_recording(session_id) -> StringIO`

**get** `/live/sessions/{session_id}/content`

Get Live session content

### Parameters

- `session_id: String`

  The ID of the stored Live session to download. Use the session ID returned when the session started with storage enabled.

### Returns

- `StringIO`

### Example

```ruby
require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

response = openai.live.sessions.download_recording("live_SQ")

puts(response)
```

## Fork session

`live.sessions.fork(session_id, **kwargs) -> SessionForkResponse`

**post** `/live/sessions/{session_id}/fork`

Fork a stored Live session onto a new WebRTC connection.

### Parameters

- `session_id: String`

- `transport: Transport{ sdp, type}`

  WebRTC transport with an SDP offer for the new connection to the forked session.

  - `sdp: String`

    Session Description Protocol message for the WebRTC connection.

  - `type: :webrtc`

    The transport used for the Live session. Always `webrtc`.

    - `:webrtc`

- `session: MediaSessionForkConfig`

  Optional configuration overrides for the new Live session. Omit this object or send an empty object to inherit the stored session's settings.

  - `client: ClientConfig`

    Startup-only capabilities for an untrusted frontend attached to a unified WebRTC session. Trusted sideband connections are unaffected.

    - `data_channel: DataChannelConfig`

      Client and server event permissions for the WebRTC frontend data channel.

      - `allowed_client_events: :all | Array[String]`

        Client event types that the frontend data channel may send. Use 'all' to allow every client event; an empty array allows none. Omission preserves the existing allow-all behavior.

        - `AllowedClientEvents = :all`

          - `:all`

        - `UnionMember1 = Array[String]`

      - `allowed_server_events: :all | Array[ServerEventSelector]`

        Server events that may be sent to the frontend data channel. Use 'all' to allow every server event; an empty array allows none. Omission preserves the existing allow-all behavior. Responses events use an object with type 'response.event' and a response_event selector.

        - `AllowedServerEvents = :all`

          - `:all`

        - `EventSelectors = Array[ServerEventSelector]`

          - `type: String`

            The outer Live server event type. Use 'response.event' for Responses events.

          - `response_event: String`

            The nested Responses event type. Required when type is 'response.event'; forbidden for other event types.

  - `delegation: Delegation{ type, responses}`

    Update the Responses backend for an existing Live session without changing delegation ownership.

    - `type: :responses`

      The delegation owner. Always `responses` for tasks handled by the Responses API.

      - `:responses`

    - `responses: ResponsesDelegationUpdateConfig`

      Responses backend settings to update. Omitted settings keep their existing values.

      - `instructions: String`

        Instructions for the delegated Responses model, separate from Live instructions. See [backend prompting](/api/docs/guides/live-delegation#start-with-your-existing-backend-prompt).

      - `max_output_tokens: Integer`

        Maximum number of output tokens for each delegated response.

      - `model: String`

        The Responses backend model to use for subsequent delegated requests. Omit to keep the current backend model.

      - `parallel_tool_calls: bool`

        Whether the delegated Responses model may request multiple tool calls in a single response.

      - `reasoning: Reasoning{ effort, summary}`

        Reasoning settings passed to each delegated Responses request.

        - `effort: :none | :minimal | :low | 3 more`

          How much reasoning effort the delegated Responses model should use. Supported values depend on the backend model.

          - `:none`

          - `:minimal`

          - `:low`

          - `:medium`

          - `:high`

          - `:xhigh`

        - `summary: :concise | :detailed | :auto`

          The reasoning summary to request from the delegated Responses model, when supported.

          - `:concise`

          - `:detailed`

          - `:auto`

      - `service_tier: :auto | :default | :fast_tier_temp_pilot | 3 more`

        Service tier for delegated Responses requests.

        - `:auto`

        - `:default`

        - `:fast_tier_temp_pilot`

        - `:flex`

        - `:priority`

        - `:ultrafast`

      - `text: Text{ verbosity}`

        Text generation settings passed to each delegated Responses request.

        - `verbosity: :low | :medium | :high`

          The amount of detail in text generated by the Responses backend. This does not configure the Live model’s spoken delivery.

          - `:low`

          - `:medium`

          - `:high`

      - `tool_choice: :auto | :none | :required | LiveFunctionToolChoiceParam{ name, type} | LiveMCPToolChoiceParam{ name, server_label, type}`

        Controls which tool the Responses backend uses when handling a task delegated by the Live model.

        - `LiveToolChoiceEnum = :auto | :none | :required`

          - `:auto`

          - `:none`

          - `:required`

        - `class LiveFunctionToolChoiceParam`

          - `name: String`

          - `type: :function`

            - `:function`

        - `class LiveMCPToolChoiceParam`

          - `name: String`

          - `server_label: String`

          - `type: :mcp`

            - `:mcp`

      - `tools: Array[FunctionTool | WebSearch{ type}]`

        Tools available to the Responses backend while it handles tasks delegated by the Live model.

        - `class FunctionTool`

          A function tool available to the Responses backend when the Live model delegates a task.

          - `name: String`

            The name the delegated Responses model uses when calling this function.

          - `type: :function`

            The tool type. Always `function`.

            - `:function`

          - `description: String`

            What the function does and when the delegated Responses model should call it.

          - `parameters: Hash[Symbol, untyped]`

            A JSON Schema object describing the arguments accepted by the function.

          - `strict: bool`

            Whether the delegated Responses model must follow the function’s parameter schema exactly.

        - `class WebSearch`

          A web search tool available to the Live session’s Responses backend.

          - `type: :web_search`

            The tool type. Always `web_search`.

            - `:web_search`

  - `store: bool`

    Whether to store the forked session. Omission inherits the stored session's setting.

### Returns

- `class SessionForkResponse`

  The created Live session identifier and WebRTC answer. Apply transport.sdp as the peer's remote answer and wait for session.started on the data channel before sending commands.

  - `session: Session{ id}`

    The newly created Live session. Use its ID for session controls and sideband connections.

    - `id: String`

      Opaque session identifier. Preserve the returned value unchanged, including its prefix.

  - `transport: Transport{ sdp, type}`

    WebRTC transport with the SDP answer.

    - `sdp: String`

      Session Description Protocol message for the WebRTC connection.

    - `type: :webrtc`

      The transport used for the Live session. Always `webrtc`.

      - `:webrtc`

### Example

```ruby
require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

response = openai.live.sessions.fork("session_id", transport: {sdp: "x", type: :webrtc})

puts(response)
```

#### Response

```json
{
  "session": {
    "id": "id"
  },
  "transport": {
    "sdp": "x",
    "type": "webrtc"
  }
}
```

## Hang up session

`live.sessions.hangup(session_id) -> void`

**post** `/live/sessions/{session_id}/hangup`

End a SIP call identified by session_id.

### Parameters

- `session_id: String`

### Example

```ruby
require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

result = openai.live.sessions.hangup("session_id")

puts(result)
```

## Transfer call

`live.sessions.refer(session_id, **kwargs) -> void`

**post** `/live/sessions/{session_id}/refer`

Transfer a SIP call to another destination. Supply a nonblank target_uri for the SIP Refer-To header.

### Parameters

- `session_id: String`

- `target_uri: String`

  Nonblank URI for the SIP Refer-To header, such as tel:+14155550123 or sip:agent@example.com.

### Example

```ruby
require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

result = openai.live.sessions.refer("session_id", target_uri: "tel:+14155550123")

puts(result)
```

## Reject call

`live.sessions.reject(session_id, **kwargs) -> void`

**post** `/live/sessions/{session_id}/reject`

Reject an incoming SIP call. Send a required SIP rejection status_code between 300 and 699.

### Parameters

- `session_id: String`

- `status_code: Integer`

  SIP rejection status sent to the caller. This field is required.

### Example

```ruby
require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

result = openai.live.sessions.reject("session_id", status_code: 486)

puts(result)
```

## Domain Types

### Session Fork Response

- `class SessionForkResponse`

  The created Live session identifier and WebRTC answer. Apply transport.sdp as the peer's remote answer and wait for session.started on the data channel before sending commands.

  - `session: Session{ id}`

    The newly created Live session. Use its ID for session controls and sideband connections.

    - `id: String`

      Opaque session identifier. Preserve the returned value unchanged, including its prefix.

  - `transport: Transport{ sdp, type}`

    WebRTC transport with the SDP answer.

    - `sdp: String`

      Session Description Protocol message for the WebRTC connection.

    - `type: :webrtc`

      The transport used for the Live session. Always `webrtc`.

      - `:webrtc`