openai 7.10.0 → 7.13.0

package/resources/realtime/client-secrets.js

@@ -16,7 +16,7 @@ class ClientSecrets extends resource_1.APIResource {
      * will be applied to any sessions created using that client secret, but these can
      * also be overridden by the client connection.
      *
-     * [Learn more about authentication with client secrets over WebRTC](https://platform.openai.com/docs/guides/realtime-webrtc).
+     * [Learn more about authentication with client secrets over WebRTC](https://developers.openai.com/api/docs/guides/realtime-webrtc).
      *
      * Returns the created client secret and the effective session object. The client
      * secret is a string that looks like `ek_1234`.

package/resources/realtime/client-secrets.mjs

@@ -13,7 +13,7 @@ export class ClientSecrets extends APIResource {
      * will be applied to any sessions created using that client secret, but these can
      * also be overridden by the client connection.
      *
-     * [Learn more about authentication with client secrets over WebRTC](https://platform.openai.com/docs/guides/realtime-webrtc).
+     * [Learn more about authentication with client secrets over WebRTC](https://developers.openai.com/api/docs/guides/realtime-webrtc).
      *
      * Returns the created client secret and the effective session object. The client
      * secret is a string that looks like `ek_1234`.

package/resources/realtime/realtime.d.mts

@@ -46,7 +46,7 @@ export interface AudioTranscription {
     /**
      * An optional text to guide the model's style or continue a previous audio
      * segment. For `whisper-1`, the
-     * [prompt is a list of keywords](https://platform.openai.com/docs/guides/speech-to-text#prompting).
+     * [prompt is a list of keywords](https://developers.openai.com/api/docs/guides/speech-to-text#prompting).
      * For `gpt-4o-transcribe` models (excluding `gpt-4o-transcribe-diarize`), the
      * prompt is a free text string, for example "expect words related to technology".
      * Prompt is not supported with `gpt-realtime-whisper` in GA Realtime sessions.
@@ -964,7 +964,7 @@ export type NoiseReductionType = 'near_field' | 'far_field';
  * trigger the server to stop generating audio and emit a
  * `output_audio_buffer.cleared` event. This event should be preceded by a
  * `response.cancel` client event to stop the generation of the current response.
- * [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
+ * [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
  */
 export interface OutputAudioBufferClearEvent {
     /**
@@ -1041,7 +1041,7 @@ export interface RealtimeAudioConfigInput {
      * `null` to turn off once on. Input audio transcription is not native to the
      * model, since the model consumes audio directly. Transcription runs
      * asynchronously through
-     * [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription)
+     * [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
      * and should be treated as guidance of input audio content rather than precisely
      * what the model heard. The client can optionally set the language and prompt for
      * transcription, these offer additional guidance to the transcription service.
@@ -1858,7 +1858,7 @@ export declare namespace RealtimeResponseCreateAudioOutput {
 /**
  * Give the model access to additional tools via remote Model Context Protocol
  * (MCP) servers.
- * [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
+ * [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
  */
 export interface RealtimeResponseCreateMcpTool {
     /**
@@ -1887,7 +1887,7 @@ export interface RealtimeResponseCreateMcpTool {
      * Identifier for service connectors, like those available in ChatGPT. One of
      * `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
      * service connectors
-     * [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+     * [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
      *
      * Currently supported `connector_id` values are:
      *
@@ -2062,7 +2062,7 @@ export interface RealtimeResponseCreateParams {
     parallel_tool_calls?: boolean;
     /**
      * Reference to a prompt template and its variables.
-     * [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+     * [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
      */
     prompt?: ResponsesAPI.ResponsePrompt | null;
     /**
@@ -2242,7 +2242,7 @@ export declare namespace RealtimeServerEvent {
      * **WebRTC/SIP Only:** Emitted when the server begins streaming audio to the
      * client. This event is emitted after an audio content part has been added
      * (`response.content_part.added`) to the response.
-     * [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
+     * [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
      */
     interface OutputAudioBufferStarted {
         /**
@@ -2262,7 +2262,7 @@ export declare namespace RealtimeServerEvent {
      * **WebRTC/SIP Only:** Emitted when the output audio buffer has been completely
      * drained on the server, and no more audio is forthcoming. This event is emitted
      * after the full response data has been sent to the client (`response.done`).
-     * [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
+     * [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
      */
     interface OutputAudioBufferStopped {
         /**
@@ -2284,7 +2284,7 @@ export declare namespace RealtimeServerEvent {
      * (`input_audio_buffer.speech_started`), or when the client has emitted the
      * `output_audio_buffer.clear` event to manually cut off the current audio
      * response.
-     * [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
+     * [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
      */
     interface OutputAudioBufferCleared {
         /**
@@ -2339,7 +2339,7 @@ export interface RealtimeSession {
      * `null` to turn off once on. Input audio transcription is not native to the
      * model, since the model consumes audio directly. Transcription runs
      * asynchronously through
-     * [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription)
+     * [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
      * and should be treated as guidance of input audio content rather than precisely
      * what the model heard. The client can optionally set the language and prompt for
      * transcription, these offer additional guidance to the transcription service.
@@ -2385,7 +2385,7 @@ export interface RealtimeSession {
     output_audio_format?: 'pcm16' | 'g711_ulaw' | 'g711_alaw';
     /**
      * Reference to a prompt template and its variables.
-     * [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+     * [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
      */
     prompt?: ResponsesAPI.ResponsePrompt | null;
     /**
@@ -2625,7 +2625,7 @@ export interface RealtimeSessionCreateRequest {
     parallel_tool_calls?: boolean;
     /**
      * Reference to a prompt template and its variables.
-     * [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+     * [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
      */
     prompt?: ResponsesAPI.ResponsePrompt | null;
     /**
@@ -2685,14 +2685,14 @@ export type RealtimeToolsConfig = Array<RealtimeToolsConfigUnion>;
 /**
  * Give the model access to additional tools via remote Model Context Protocol
  * (MCP) servers.
- * [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
+ * [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
  */
 export type RealtimeToolsConfigUnion = RealtimeFunctionTool | RealtimeToolsConfigUnion.Mcp;
 export declare namespace RealtimeToolsConfigUnion {
     /**
      * Give the model access to additional tools via remote Model Context Protocol
      * (MCP) servers.
-     * [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
+     * [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
      */
     interface Mcp {
         /**
@@ -2721,7 +2721,7 @@ export declare namespace RealtimeToolsConfigUnion {
          * Identifier for service connectors, like those available in ChatGPT. One of
          * `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
          * service connectors
-         * [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+         * [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
          *
          * Currently supported `connector_id` values are:
          *
@@ -2888,7 +2888,7 @@ export interface RealtimeTranscriptionSessionAudioInput {
      * `null` to turn off once on. Input audio transcription is not native to the
      * model, since the model consumes audio directly. Transcription runs
      * asynchronously through
-     * [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription)
+     * [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
      * and should be treated as guidance of input audio content rather than precisely
      * what the model heard. The client can optionally set the language and prompt for
      * transcription, these offer additional guidance to the transcription service.

package/resources/realtime/realtime.d.ts

@@ -46,7 +46,7 @@ export interface AudioTranscription {
     /**
      * An optional text to guide the model's style or continue a previous audio
      * segment. For `whisper-1`, the
-     * [prompt is a list of keywords](https://platform.openai.com/docs/guides/speech-to-text#prompting).
+     * [prompt is a list of keywords](https://developers.openai.com/api/docs/guides/speech-to-text#prompting).
      * For `gpt-4o-transcribe` models (excluding `gpt-4o-transcribe-diarize`), the
      * prompt is a free text string, for example "expect words related to technology".
      * Prompt is not supported with `gpt-realtime-whisper` in GA Realtime sessions.
@@ -964,7 +964,7 @@ export type NoiseReductionType = 'near_field' | 'far_field';
  * trigger the server to stop generating audio and emit a
  * `output_audio_buffer.cleared` event. This event should be preceded by a
  * `response.cancel` client event to stop the generation of the current response.
- * [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
+ * [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
  */
 export interface OutputAudioBufferClearEvent {
     /**
@@ -1041,7 +1041,7 @@ export interface RealtimeAudioConfigInput {
      * `null` to turn off once on. Input audio transcription is not native to the
      * model, since the model consumes audio directly. Transcription runs
      * asynchronously through
-     * [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription)
+     * [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
      * and should be treated as guidance of input audio content rather than precisely
      * what the model heard. The client can optionally set the language and prompt for
      * transcription, these offer additional guidance to the transcription service.
@@ -1858,7 +1858,7 @@ export declare namespace RealtimeResponseCreateAudioOutput {
 /**
  * Give the model access to additional tools via remote Model Context Protocol
  * (MCP) servers.
- * [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
+ * [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
  */
 export interface RealtimeResponseCreateMcpTool {
     /**
@@ -1887,7 +1887,7 @@ export interface RealtimeResponseCreateMcpTool {
      * Identifier for service connectors, like those available in ChatGPT. One of
      * `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
      * service connectors
-     * [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+     * [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
      *
      * Currently supported `connector_id` values are:
      *
@@ -2062,7 +2062,7 @@ export interface RealtimeResponseCreateParams {
     parallel_tool_calls?: boolean;
     /**
      * Reference to a prompt template and its variables.
-     * [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+     * [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
      */
     prompt?: ResponsesAPI.ResponsePrompt | null;
     /**
@@ -2242,7 +2242,7 @@ export declare namespace RealtimeServerEvent {
      * **WebRTC/SIP Only:** Emitted when the server begins streaming audio to the
      * client. This event is emitted after an audio content part has been added
      * (`response.content_part.added`) to the response.
-     * [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
+     * [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
      */
     interface OutputAudioBufferStarted {
         /**
@@ -2262,7 +2262,7 @@ export declare namespace RealtimeServerEvent {
      * **WebRTC/SIP Only:** Emitted when the output audio buffer has been completely
      * drained on the server, and no more audio is forthcoming. This event is emitted
      * after the full response data has been sent to the client (`response.done`).
-     * [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
+     * [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
      */
     interface OutputAudioBufferStopped {
         /**
@@ -2284,7 +2284,7 @@ export declare namespace RealtimeServerEvent {
      * (`input_audio_buffer.speech_started`), or when the client has emitted the
      * `output_audio_buffer.clear` event to manually cut off the current audio
      * response.
-     * [Learn more](https://platform.openai.com/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
+     * [Learn more](https://developers.openai.com/api/docs/guides/realtime-conversations#client-and-server-events-for-audio-in-webrtc).
      */
     interface OutputAudioBufferCleared {
         /**
@@ -2339,7 +2339,7 @@ export interface RealtimeSession {
      * `null` to turn off once on. Input audio transcription is not native to the
      * model, since the model consumes audio directly. Transcription runs
      * asynchronously through
-     * [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription)
+     * [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
      * and should be treated as guidance of input audio content rather than precisely
      * what the model heard. The client can optionally set the language and prompt for
      * transcription, these offer additional guidance to the transcription service.
@@ -2385,7 +2385,7 @@ export interface RealtimeSession {
     output_audio_format?: 'pcm16' | 'g711_ulaw' | 'g711_alaw';
     /**
      * Reference to a prompt template and its variables.
-     * [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+     * [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
      */
     prompt?: ResponsesAPI.ResponsePrompt | null;
     /**
@@ -2625,7 +2625,7 @@ export interface RealtimeSessionCreateRequest {
     parallel_tool_calls?: boolean;
     /**
      * Reference to a prompt template and its variables.
-     * [Learn more](https://platform.openai.com/docs/guides/text?api-mode=responses#reusable-prompts).
+     * [Learn more](https://developers.openai.com/api/docs/guides/text?api-mode=responses#version-prompts-in-code).
      */
     prompt?: ResponsesAPI.ResponsePrompt | null;
     /**
@@ -2685,14 +2685,14 @@ export type RealtimeToolsConfig = Array<RealtimeToolsConfigUnion>;
 /**
  * Give the model access to additional tools via remote Model Context Protocol
  * (MCP) servers.
- * [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
+ * [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
  */
 export type RealtimeToolsConfigUnion = RealtimeFunctionTool | RealtimeToolsConfigUnion.Mcp;
 export declare namespace RealtimeToolsConfigUnion {
     /**
      * Give the model access to additional tools via remote Model Context Protocol
      * (MCP) servers.
-     * [Learn more about MCP](https://platform.openai.com/docs/guides/tools-remote-mcp).
+     * [Learn more about MCP](https://developers.openai.com/api/docs/guides/tools-connectors-mcp).
      */
     interface Mcp {
         /**
@@ -2721,7 +2721,7 @@ export declare namespace RealtimeToolsConfigUnion {
          * Identifier for service connectors, like those available in ChatGPT. One of
          * `server_url`, `connector_id`, or `tunnel_id` must be provided. Learn more about
          * service connectors
-         * [here](https://platform.openai.com/docs/guides/tools-remote-mcp#connectors).
+         * [here](https://developers.openai.com/api/docs/guides/tools-connectors-mcp#connectors).
          *
          * Currently supported `connector_id` values are:
          *
@@ -2888,7 +2888,7 @@ export interface RealtimeTranscriptionSessionAudioInput {
      * `null` to turn off once on. Input audio transcription is not native to the
      * model, since the model consumes audio directly. Transcription runs
      * asynchronously through
-     * [the /audio/transcriptions endpoint](https://platform.openai.com/docs/api-reference/audio/createTranscription)
+     * [the /audio/transcriptions endpoint](https://developers.openai.com/api/reference/resources/audio/subresources/transcriptions/methods/create)
      * and should be treated as guidance of input audio content rather than precisely
      * what the model heard. The client can optionally set the language and prompt for
      * transcription, these offer additional guidance to the transcription service.

package/resources/responses/input-tokens.d.mts

@@ -44,8 +44,8 @@ export interface InputTokenCountParams {
      * Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
      * wide range of models with different capabilities, performance characteristics,
      * and price points. Refer to the
-     * [model guide](https://platform.openai.com/docs/models) to browse and compare
-     * available models.
+     * [model guide](https://developers.openai.com/api/docs/models) to browse and
+     * compare available models.
      */
     model?: string | null;
     /**
@@ -61,21 +61,21 @@ export interface InputTokenCountParams {
     /**
      * The unique ID of the previous response to the model. Use this to create
      * multi-turn conversations. Learn more about
-     * [conversation state](https://platform.openai.com/docs/guides/conversation-state).
+     * [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
      * Cannot be used in conjunction with `conversation`.
      */
     previous_response_id?: string | null;
     /**
      * **gpt-5 and o-series models only** Configuration options for
-     * [reasoning models](https://platform.openai.com/docs/guides/reasoning).
+     * [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
      */
     reasoning?: Shared.Reasoning | null;
     /**
      * Configuration options for a text response from the model. Can be plain text or
      * structured JSON data. Learn more:
      *
-     * - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-     * - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+     * - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+     * - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
      */
     text?: InputTokenCountParams.Text | null;
     /**
@@ -102,8 +102,8 @@ export declare namespace InputTokenCountParams {
      * Configuration options for a text response from the model. Can be plain text or
      * structured JSON data. Learn more:
      *
-     * - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-     * - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+     * - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+     * - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
      */
     interface Text {
         /**
@@ -111,7 +111,7 @@ export declare namespace InputTokenCountParams {
          *
          * Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
          * ensures the model will match your supplied JSON schema. Learn more in the
-         * [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+         * [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
          *
          * The default format is `{ "type": "text" }` with no additional options.
          *

package/resources/responses/input-tokens.d.ts

@@ -44,8 +44,8 @@ export interface InputTokenCountParams {
      * Model ID used to generate the response, like `gpt-4o` or `o3`. OpenAI offers a
      * wide range of models with different capabilities, performance characteristics,
      * and price points. Refer to the
-     * [model guide](https://platform.openai.com/docs/models) to browse and compare
-     * available models.
+     * [model guide](https://developers.openai.com/api/docs/models) to browse and
+     * compare available models.
      */
     model?: string | null;
     /**
@@ -61,21 +61,21 @@ export interface InputTokenCountParams {
     /**
      * The unique ID of the previous response to the model. Use this to create
      * multi-turn conversations. Learn more about
-     * [conversation state](https://platform.openai.com/docs/guides/conversation-state).
+     * [conversation state](https://developers.openai.com/api/docs/guides/conversation-state).
      * Cannot be used in conjunction with `conversation`.
      */
     previous_response_id?: string | null;
     /**
      * **gpt-5 and o-series models only** Configuration options for
-     * [reasoning models](https://platform.openai.com/docs/guides/reasoning).
+     * [reasoning models](https://developers.openai.com/api/docs/guides/reasoning).
      */
     reasoning?: Shared.Reasoning | null;
     /**
      * Configuration options for a text response from the model. Can be plain text or
      * structured JSON data. Learn more:
      *
-     * - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-     * - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+     * - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+     * - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
      */
     text?: InputTokenCountParams.Text | null;
     /**
@@ -102,8 +102,8 @@ export declare namespace InputTokenCountParams {
      * Configuration options for a text response from the model. Can be plain text or
      * structured JSON data. Learn more:
      *
-     * - [Text inputs and outputs](https://platform.openai.com/docs/guides/text)
-     * - [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs)
+     * - [Text inputs and outputs](https://developers.openai.com/api/docs/guides/text)
+     * - [Structured Outputs](https://developers.openai.com/api/docs/guides/structured-outputs)
      */
     interface Text {
         /**
@@ -111,7 +111,7 @@ export declare namespace InputTokenCountParams {
          *
          * Configuring `{ "type": "json_schema" }` enables Structured Outputs, which
          * ensures the model will match your supplied JSON schema. Learn more in the
-         * [Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs).
+         * [Structured Outputs guide](https://developers.openai.com/api/docs/guides/structured-outputs).
          *
          * The default format is `{ "type": "text" }` with no additional options.
          *