--- title: "RealtimeSession" url: "https://kongair.terwilligar.com/apis/openai-api-2-3-0/versions/ea92d048-c746-4ead-a6a8-da28d93137d1/schemas/RealtimeSession" --- > Full API specification: https://kongair.terwilligar.com/apis/openai-api-2-3-0/versions/ea92d048-c746-4ead-a6a8-da28d93137d1.md # RealtimeSession Realtime session object configuration. ## OpenAPI definition ```yaml openapi: 3.0.0 info: title: OpenAI API version: 2.3.0 servers: - url: https://api.openai.com/v1 components: schemas: RealtimeSession: type: object description: Realtime session object configuration. properties: id: type: string description: | Unique identifier for the session object. modalities: description: | The set of modalities the model can respond with. To disable audio, set this to ["text"]. items: type: string enum: - text - audio model: description: | The Realtime model used for this session. anyOf: - type: string - type: string enum: - gpt-4o-realtime-preview - gpt-4o-realtime-preview-2024-10-01 - gpt-4o-realtime-preview-2024-12-17 - gpt-4o-mini-realtime-preview - gpt-4o-mini-realtime-preview-2024-12-17 instructions: type: string description: > 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. voice: type: string enum: - alloy - ash - ballad - coral - echo - sage - shimmer - verse description: > The voice the model uses to respond. Voice cannot be changed during the session once the model has responded with audio at least once. Current voice options are `alloy`, `ash`, `ballad`, `coral`, `echo` `sage`, `shimmer` and `verse`. input_audio_format: type: string enum: - pcm16 - g711_ulaw - g711_alaw description: > The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`. For `pcm16`, input audio must be 16-bit PCM at a 24kHz sample rate, single channel (mono), and little-endian byte order. output_audio_format: type: string enum: - pcm16 - g711_ulaw - g711_alaw description: > The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`. For `pcm16`, output audio is sampled at a rate of 24kHz. input_audio_transcription: type: object description: > Configuration for input audio transcription, defaults to off and can be set to `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 Whisper and should be treated as rough guidance rather than the representation understood by the model. properties: model: type: string description: > The model to use for transcription, `whisper-1` is the only currently supported model. turn_detection: type: object nullable: true description: > Configuration for turn detection. Can be set to `null` to turn off. Server VAD means that the model will detect the start and end of speech based on audio volume and respond at the end of user speech. properties: type: type: string enum: - server_vad description: > Type of turn detection, only `server_vad` is currently supported. x-stainless-const: true threshold: type: number description: > Activation threshold for VAD (0.0 to 1.0), this defaults to 0.5. A higher threshold will require louder audio to activate the model, and thus might perform better in noisy environments. prefix_padding_ms: type: integer description: | Amount of audio to include before the VAD detected speech (in milliseconds). Defaults to 300ms. silence_duration_ms: type: integer description: > Duration of silence to detect speech stop (in milliseconds). Defaults to 500ms. With shorter values the model will respond more quickly, but may jump in on short pauses from the user. tools: type: array description: Tools (functions) available to the model. items: type: object properties: type: type: string enum: - function description: The type of the tool, i.e. `function`. x-stainless-const: true name: type: string description: The name of the function. description: type: string description: > The description of the function, including guidance on when and how to call it, and guidance about what to tell the user when calling (if anything). parameters: type: object description: Parameters of the function in JSON Schema. tool_choice: type: string description: > How the model chooses tools. Options are `auto`, `none`, `required`, or specify a function. temperature: type: number description: > Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8. max_response_output_tokens: oneOf: - type: integer - type: string enum: - inf x-stainless-const: true description: | 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`. ```