openai 0.28.0 → 0.29.0

data/rbi/openai/resources/realtime/calls.rbi

@@ -0,0 +1,182 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Realtime
+      class Calls
+        # Accept an incoming SIP call and configure the realtime session that will handle
+        # it.
+        sig do
+          params(
+            call_id: String,
+            audio: OpenAI::Realtime::RealtimeAudioConfig::OrHash,
+            include:
+              T::Array[
+                OpenAI::Realtime::RealtimeSessionCreateRequest::Include::OrSymbol
+              ],
+            instructions: String,
+            max_output_tokens: T.any(Integer, Symbol),
+            model:
+              T.any(
+                String,
+                OpenAI::Realtime::RealtimeSessionCreateRequest::Model::OrSymbol
+              ),
+            output_modalities:
+              T::Array[
+                OpenAI::Realtime::RealtimeSessionCreateRequest::OutputModality::OrSymbol
+              ],
+            prompt: T.nilable(OpenAI::Responses::ResponsePrompt::OrHash),
+            tool_choice:
+              T.any(
+                OpenAI::Responses::ToolChoiceOptions::OrSymbol,
+                OpenAI::Responses::ToolChoiceFunction::OrHash,
+                OpenAI::Responses::ToolChoiceMcp::OrHash
+              ),
+            tools:
+              T::Array[
+                T.any(
+                  OpenAI::Realtime::RealtimeFunctionTool::OrHash,
+                  OpenAI::Realtime::RealtimeToolsConfigUnion::Mcp::OrHash
+                )
+              ],
+            tracing:
+              T.nilable(
+                T.any(
+                  Symbol,
+                  OpenAI::Realtime::RealtimeTracingConfig::TracingConfiguration::OrHash
+                )
+              ),
+            truncation:
+              T.any(
+                OpenAI::Realtime::RealtimeTruncation::RealtimeTruncationStrategy::OrSymbol,
+                OpenAI::Realtime::RealtimeTruncationRetentionRatio::OrHash
+              ),
+            type: Symbol,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).void
+        end
+        def accept(
+          # The identifier for the call provided in the
+          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook_events/realtime/call/incoming)
+          # webhook.
+          call_id,
+          # Configuration for input and output audio.
+          audio: nil,
+          # Additional fields to include in server outputs.
+          #
+          # `item.input_audio_transcription.logprobs`: Include logprobs for input audio
+          # transcription.
+          include: nil,
+          # The default system instructions (i.e. system message) prepended to model calls.
+          # This field allows the client to guide the model on desired responses. The model
+          # can be instructed on response content and format, (e.g. "be extremely succinct",
+          # "act friendly", "here are examples of good responses") and on audio behavior
+          # (e.g. "talk quickly", "inject emotion into your voice", "laugh frequently"). The
+          # instructions are not guaranteed to be followed by the model, but they provide
+          # guidance to the model on the desired behavior.
+          #
+          # Note that the server sets default instructions which will be used if this field
+          # is not set and are visible in the `session.created` event at the start of the
+          # session.
+          instructions: nil,
+          # Maximum number of output tokens for a single assistant response, inclusive of
+          # tool calls. Provide an integer between 1 and 4096 to limit output tokens, or
+          # `inf` for the maximum available tokens for a given model. Defaults to `inf`.
+          max_output_tokens: nil,
+          # The Realtime model used for this session.
+          model: nil,
+          # The set of modalities the model can respond with. It defaults to `["audio"]`,
+          # indicating that the model will respond with audio plus a transcript. `["text"]`
+          # can be used to make the model respond with text only. It is not possible to
+          # request both `text` and `audio` at the same time.
+          output_modalities: nil,
+          # Reference to a prompt template and its variables.
+          # [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+          prompt: nil,
+          # How the model chooses tools. Provide one of the string modes or force a specific
+          # function/MCP tool.
+          tool_choice: nil,
+          # Tools available to the model.
+          tools: nil,
+          # Realtime API can write session traces to the
+          # [Traces Dashboard](/logs?api=traces). Set to null to disable tracing. Once
+          # tracing is enabled for a session, the configuration cannot be modified.
+          #
+          # `auto` will create a trace for the session with default values for the workflow
+          # name, group id, and metadata.
+          tracing: nil,
+          # Controls how the realtime conversation is truncated prior to model inference.
+          # The default is `auto`.
+          truncation: nil,
+          # The type of session to create. Always `realtime` for the Realtime API.
+          type: :realtime,
+          request_options: {}
+        )
+        end
+
+        # End an active Realtime API call, whether it was initiated over SIP or WebRTC.
+        sig do
+          params(
+            call_id: String,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).void
+        end
+        def hangup(
+          # The identifier for the call. For SIP calls, use the value provided in the
+          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook_events/realtime/call/incoming)
+          # webhook. For WebRTC sessions, reuse the call ID returned in the `Location`
+          # header when creating the call with
+          # [`POST /v1/realtime/calls`](https://platform.openai.com/docs/api-reference/realtime/create-call).
+          call_id,
+          request_options: {}
+        )
+        end
+
+        # Transfer an active SIP call to a new destination using the SIP REFER verb.
+        sig do
+          params(
+            call_id: String,
+            target_uri: String,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).void
+        end
+        def refer(
+          # The identifier for the call provided in the
+          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook_events/realtime/call/incoming)
+          # webhook.
+          call_id,
+          # URI that should appear in the SIP Refer-To header. Supports values like
+          # `tel:+14155550123` or `sip:agent@example.com`.
+          target_uri:,
+          request_options: {}
+        )
+        end
+
+        # Decline an incoming SIP call by returning a SIP status code to the caller.
+        sig do
+          params(
+            call_id: String,
+            status_code: Integer,
+            request_options: OpenAI::RequestOptions::OrHash
+          ).void
+        end
+        def reject(
+          # The identifier for the call provided in the
+          # [`realtime.call.incoming`](https://platform.openai.com/docs/api-reference/webhook_events/realtime/call/incoming)
+          # webhook.
+          call_id,
+          # SIP response code to send back to the caller. Defaults to `603` (Decline) when
+          # omitted.
+          status_code: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: OpenAI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/realtime.rbi

@@ -6,6 +6,9 @@ module OpenAI
       sig { returns(OpenAI::Resources::Realtime::ClientSecrets) }
       attr_reader :client_secrets
 
+      sig { returns(OpenAI::Resources::Realtime::Calls) }
+      attr_reader :calls
+
       # @api private
       sig { params(client: OpenAI::Client).returns(T.attached_class) }
       def self.new(client:)

data/sig/openai/models/conversations/conversation_item.rbs

@@ -356,8 +356,10 @@ module OpenAI
             name: String,
             server_label: String,
             type: :mcp_call,
+            approval_request_id: String?,
             error: String?,
-            output: String?
+            output: String?,
+            status: OpenAI::Models::Conversations::ConversationItem::McpCall::status
           }
 
         class McpCall < OpenAI::Internal::Type::BaseModel
@@ -371,17 +373,27 @@ module OpenAI
 
           attr_accessor type: :mcp_call
 
+          attr_accessor approval_request_id: String?
+
           attr_accessor error: String?
 
           attr_accessor output: String?
 
+          attr_reader status: OpenAI::Models::Conversations::ConversationItem::McpCall::status?
+
+          def status=: (
+            OpenAI::Models::Conversations::ConversationItem::McpCall::status
+          ) -> OpenAI::Models::Conversations::ConversationItem::McpCall::status
+
           def initialize: (
             id: String,
             arguments: String,
             name: String,
             server_label: String,
+            ?approval_request_id: String?,
             ?error: String?,
             ?output: String?,
+            ?status: OpenAI::Models::Conversations::ConversationItem::McpCall::status,
             ?type: :mcp_call
           ) -> void
 
@@ -391,9 +403,26 @@ module OpenAI
             name: String,
             server_label: String,
             type: :mcp_call,
+            approval_request_id: String?,
             error: String?,
-            output: String?
+            output: String?,
+            status: OpenAI::Models::Conversations::ConversationItem::McpCall::status
           }
+
+          type status =
+            :in_progress | :completed | :incomplete | :calling | :failed
+
+          module Status
+            extend OpenAI::Internal::Type::Enum
+
+            IN_PROGRESS: :in_progress
+            COMPLETED: :completed
+            INCOMPLETE: :incomplete
+            CALLING: :calling
+            FAILED: :failed
+
+            def self?.values: -> ::Array[OpenAI::Models::Conversations::ConversationItem::McpCall::status]
+          end
         end
 
         def self?.variants: -> ::Array[OpenAI::Models::Conversations::conversation_item]

data/sig/openai/models/realtime/call_accept_params.rbs

@@ -0,0 +1,17 @@
+module OpenAI
+  module Models
+    module Realtime
+      type call_accept_params =
+        {  } & OpenAI::Internal::Type::request_parameters
+
+      class CallAcceptParams < OpenAI::Models::Realtime::RealtimeSessionCreateRequest
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: OpenAI::request_opts) -> void
+
+        def to_hash: -> { request_options: OpenAI::RequestOptions }
+      end
+    end
+  end
+end

data/sig/openai/models/realtime/call_hangup_params.rbs

@@ -0,0 +1,17 @@
+module OpenAI
+  module Models
+    module Realtime
+      type call_hangup_params =
+        {  } & OpenAI::Internal::Type::request_parameters
+
+      class CallHangupParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        def initialize: (?request_options: OpenAI::request_opts) -> void
+
+        def to_hash: -> { request_options: OpenAI::RequestOptions }
+      end
+    end
+  end
+end

data/sig/openai/models/realtime/call_refer_params.rbs

@@ -0,0 +1,25 @@
+module OpenAI
+  module Models
+    module Realtime
+      type call_refer_params =
+        { target_uri: String } & OpenAI::Internal::Type::request_parameters
+
+      class CallReferParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_accessor target_uri: String
+
+        def initialize: (
+          target_uri: String,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          target_uri: String,
+          request_options: OpenAI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/realtime/call_reject_params.rbs

@@ -0,0 +1,27 @@
+module OpenAI
+  module Models
+    module Realtime
+      type call_reject_params =
+        { status_code: Integer } & OpenAI::Internal::Type::request_parameters
+
+      class CallRejectParams < OpenAI::Internal::Type::BaseModel
+        extend OpenAI::Internal::Type::RequestParameters::Converter
+        include OpenAI::Internal::Type::RequestParameters
+
+        attr_reader status_code: Integer?
+
+        def status_code=: (Integer) -> Integer
+
+        def initialize: (
+          ?status_code: Integer,
+          ?request_options: OpenAI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          status_code: Integer,
+          request_options: OpenAI::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/openai/models/responses/response_input_item.rbs

@@ -563,8 +563,10 @@ module OpenAI
             name: String,
             server_label: String,
             type: :mcp_call,
+            approval_request_id: String?,
             error: String?,
-            output: String?
+            output: String?,
+            status: OpenAI::Models::Responses::ResponseInputItem::McpCall::status
           }
 
         class McpCall < OpenAI::Internal::Type::BaseModel
@@ -578,17 +580,27 @@ module OpenAI
 
           attr_accessor type: :mcp_call
 
+          attr_accessor approval_request_id: String?
+
           attr_accessor error: String?
 
           attr_accessor output: String?
 
+          attr_reader status: OpenAI::Models::Responses::ResponseInputItem::McpCall::status?
+
+          def status=: (
+            OpenAI::Models::Responses::ResponseInputItem::McpCall::status
+          ) -> OpenAI::Models::Responses::ResponseInputItem::McpCall::status
+
           def initialize: (
             id: String,
             arguments: String,
             name: String,
             server_label: String,
+            ?approval_request_id: String?,
             ?error: String?,
             ?output: String?,
+            ?status: OpenAI::Models::Responses::ResponseInputItem::McpCall::status,
             ?type: :mcp_call
           ) -> void
 
@@ -598,9 +610,26 @@ module OpenAI
             name: String,
             server_label: String,
             type: :mcp_call,
+            approval_request_id: String?,
             error: String?,
-            output: String?
+            output: String?,
+            status: OpenAI::Models::Responses::ResponseInputItem::McpCall::status
           }
+
+          type status =
+            :in_progress | :completed | :incomplete | :calling | :failed
+
+          module Status
+            extend OpenAI::Internal::Type::Enum
+
+            IN_PROGRESS: :in_progress
+            COMPLETED: :completed
+            INCOMPLETE: :incomplete
+            CALLING: :calling
+            FAILED: :failed
+
+            def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseInputItem::McpCall::status]
+          end
         end
 
         type item_reference =

data/sig/openai/models/responses/response_item.rbs

@@ -352,8 +352,10 @@ module OpenAI
             name: String,
             server_label: String,
             type: :mcp_call,
+            approval_request_id: String?,
             error: String?,
-            output: String?
+            output: String?,
+            status: OpenAI::Models::Responses::ResponseItem::McpCall::status
           }
 
         class McpCall < OpenAI::Internal::Type::BaseModel
@@ -367,17 +369,27 @@ module OpenAI
 
           attr_accessor type: :mcp_call
 
+          attr_accessor approval_request_id: String?
+
           attr_accessor error: String?
 
           attr_accessor output: String?
 
+          attr_reader status: OpenAI::Models::Responses::ResponseItem::McpCall::status?
+
+          def status=: (
+            OpenAI::Models::Responses::ResponseItem::McpCall::status
+          ) -> OpenAI::Models::Responses::ResponseItem::McpCall::status
+
           def initialize: (
             id: String,
             arguments: String,
             name: String,
             server_label: String,
+            ?approval_request_id: String?,
             ?error: String?,
             ?output: String?,
+            ?status: OpenAI::Models::Responses::ResponseItem::McpCall::status,
             ?type: :mcp_call
           ) -> void
 
@@ -387,9 +399,26 @@ module OpenAI
             name: String,
             server_label: String,
             type: :mcp_call,
+            approval_request_id: String?,
             error: String?,
-            output: String?
+            output: String?,
+            status: OpenAI::Models::Responses::ResponseItem::McpCall::status
           }
+
+          type status =
+            :in_progress | :completed | :incomplete | :calling | :failed
+
+          module Status
+            extend OpenAI::Internal::Type::Enum
+
+            IN_PROGRESS: :in_progress
+            COMPLETED: :completed
+            INCOMPLETE: :incomplete
+            CALLING: :calling
+            FAILED: :failed
+
+            def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseItem::McpCall::status]
+          end
         end
 
         def self?.variants: -> ::Array[OpenAI::Models::Responses::response_item]

data/sig/openai/models/responses/response_output_item.rbs

@@ -162,8 +162,10 @@ module OpenAI
             name: String,
             server_label: String,
             type: :mcp_call,
+            approval_request_id: String?,
             error: String?,
-            output: String?
+            output: String?,
+            status: OpenAI::Models::Responses::ResponseOutputItem::McpCall::status
           }
 
         class McpCall < OpenAI::Internal::Type::BaseModel
@@ -177,17 +179,27 @@ module OpenAI
 
           attr_accessor type: :mcp_call
 
+          attr_accessor approval_request_id: String?
+
           attr_accessor error: String?
 
           attr_accessor output: String?
 
+          attr_reader status: OpenAI::Models::Responses::ResponseOutputItem::McpCall::status?
+
+          def status=: (
+            OpenAI::Models::Responses::ResponseOutputItem::McpCall::status
+          ) -> OpenAI::Models::Responses::ResponseOutputItem::McpCall::status
+
           def initialize: (
             id: String,
             arguments: String,
             name: String,
             server_label: String,
+            ?approval_request_id: String?,
             ?error: String?,
             ?output: String?,
+            ?status: OpenAI::Models::Responses::ResponseOutputItem::McpCall::status,
             ?type: :mcp_call
           ) -> void
 
@@ -197,9 +209,26 @@ module OpenAI
             name: String,
             server_label: String,
             type: :mcp_call,
+            approval_request_id: String?,
             error: String?,
-            output: String?
+            output: String?,
+            status: OpenAI::Models::Responses::ResponseOutputItem::McpCall::status
           }
+
+          type status =
+            :in_progress | :completed | :incomplete | :calling | :failed
+
+          module Status
+            extend OpenAI::Internal::Type::Enum
+
+            IN_PROGRESS: :in_progress
+            COMPLETED: :completed
+            INCOMPLETE: :incomplete
+            CALLING: :calling
+            FAILED: :failed
+
+            def self?.values: -> ::Array[OpenAI::Models::Responses::ResponseOutputItem::McpCall::status]
+          end
         end
 
         type mcp_list_tools =

data/sig/openai/resources/realtime/calls.rbs

@@ -0,0 +1,43 @@
+module OpenAI
+  module Resources
+    class Realtime
+      class Calls
+        def accept: (
+          String call_id,
+          ?audio: OpenAI::Realtime::RealtimeAudioConfig,
+          ?include: ::Array[OpenAI::Models::Realtime::RealtimeSessionCreateRequest::include_],
+          ?instructions: String,
+          ?max_output_tokens: OpenAI::Models::Realtime::RealtimeSessionCreateRequest::max_output_tokens,
+          ?model: OpenAI::Models::Realtime::RealtimeSessionCreateRequest::model,
+          ?output_modalities: ::Array[OpenAI::Models::Realtime::RealtimeSessionCreateRequest::output_modality],
+          ?prompt: OpenAI::Responses::ResponsePrompt?,
+          ?tool_choice: OpenAI::Models::Realtime::realtime_tool_choice_config,
+          ?tools: OpenAI::Models::Realtime::realtime_tools_config,
+          ?tracing: OpenAI::Models::Realtime::realtime_tracing_config?,
+          ?truncation: OpenAI::Models::Realtime::realtime_truncation,
+          ?type: :realtime,
+          ?request_options: OpenAI::request_opts
+        ) -> nil
+
+        def hangup: (
+          String call_id,
+          ?request_options: OpenAI::request_opts
+        ) -> nil
+
+        def refer: (
+          String call_id,
+          target_uri: String,
+          ?request_options: OpenAI::request_opts
+        ) -> nil
+
+        def reject: (
+          String call_id,
+          ?status_code: Integer,
+          ?request_options: OpenAI::request_opts
+        ) -> nil
+
+        def initialize: (client: OpenAI::Client) -> void
+      end
+    end
+  end
+end

data/sig/openai/resources/realtime.rbs

@@ -3,6 +3,8 @@ module OpenAI
     class Realtime
       attr_reader client_secrets: OpenAI::Resources::Realtime::ClientSecrets
 
+      attr_reader calls: OpenAI::Resources::Realtime::Calls
+
       def initialize: (client: OpenAI::Client) -> void
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openai
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 0.29.0
 platform: ruby
 authors:
 - OpenAI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-09-30 00:00:00.000000000 Z
+date: 2025-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -389,6 +389,10 @@ files:
 - lib/openai/models/moderation_text_input.rb
 - lib/openai/models/other_file_chunking_strategy_object.rb
 - lib/openai/models/realtime/audio_transcription.rb
+- lib/openai/models/realtime/call_accept_params.rb
+- lib/openai/models/realtime/call_hangup_params.rb
+- lib/openai/models/realtime/call_refer_params.rb
+- lib/openai/models/realtime/call_reject_params.rb
 - lib/openai/models/realtime/client_secret_create_params.rb
 - lib/openai/models/realtime/client_secret_create_response.rb
 - lib/openai/models/realtime/conversation_created_event.rb
@@ -708,6 +712,7 @@ files:
 - lib/openai/resources/models.rb
 - lib/openai/resources/moderations.rb
 - lib/openai/resources/realtime.rb
+- lib/openai/resources/realtime/calls.rb
 - lib/openai/resources/realtime/client_secrets.rb
 - lib/openai/resources/responses.rb
 - lib/openai/resources/responses/input_items.rb
@@ -1069,6 +1074,10 @@ files:
 - rbi/openai/models/moderation_text_input.rbi
 - rbi/openai/models/other_file_chunking_strategy_object.rbi
 - rbi/openai/models/realtime/audio_transcription.rbi
+- rbi/openai/models/realtime/call_accept_params.rbi
+- rbi/openai/models/realtime/call_hangup_params.rbi
+- rbi/openai/models/realtime/call_refer_params.rbi
+- rbi/openai/models/realtime/call_reject_params.rbi
 - rbi/openai/models/realtime/client_secret_create_params.rbi
 - rbi/openai/models/realtime/client_secret_create_response.rbi
 - rbi/openai/models/realtime/conversation_created_event.rbi
@@ -1388,6 +1397,7 @@ files:
 - rbi/openai/resources/models.rbi
 - rbi/openai/resources/moderations.rbi
 - rbi/openai/resources/realtime.rbi
+- rbi/openai/resources/realtime/calls.rbi
 - rbi/openai/resources/realtime/client_secrets.rbi
 - rbi/openai/resources/responses.rbi
 - rbi/openai/resources/responses/input_items.rbi
@@ -1739,6 +1749,10 @@ files:
 - sig/openai/models/moderation_text_input.rbs
 - sig/openai/models/other_file_chunking_strategy_object.rbs
 - sig/openai/models/realtime/audio_transcription.rbs
+- sig/openai/models/realtime/call_accept_params.rbs
+- sig/openai/models/realtime/call_hangup_params.rbs
+- sig/openai/models/realtime/call_refer_params.rbs
+- sig/openai/models/realtime/call_reject_params.rbs
 - sig/openai/models/realtime/client_secret_create_params.rbs
 - sig/openai/models/realtime/client_secret_create_response.rbs
 - sig/openai/models/realtime/conversation_created_event.rbs
@@ -2058,6 +2072,7 @@ files:
 - sig/openai/resources/models.rbs
 - sig/openai/resources/moderations.rbs
 - sig/openai/resources/realtime.rbs
+- sig/openai/resources/realtime/calls.rbs
 - sig/openai/resources/realtime/client_secrets.rbs
 - sig/openai/resources/responses.rbs
 - sig/openai/resources/responses/input_items.rbs