GET
/v1/schemas/openai/chat/realtime%2Fsessions
Accept:
Request body
16 properties · 1 required · 11 $defs| property | type | description | constraints |
|---|---|---|---|
| client_secret* | object | Ephemeral key returned by the API. | |
| modalities | any | The set of modalities the model can respond with. To disable audio, set this to ["text"]. | |
| instructions | string | 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", "he… | |
| voice | string | enum | object | The voice the model uses to respond. Supported built-in voices are `alloy`, `ash`, `ballad`, `coral`, `echo`, `sage`, `shimmer`, `verse`, `marin`, and `cedar`. You may also provide a custom voice object with an `id`, for example `{ "id": "voice_1234" }`. Voice… | |
| input_audio_format | string | The format of input audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`. | |
| output_audio_format | string | The format of output audio. Options are `pcm16`, `g711_ulaw`, or `g711_alaw`. | |
| input_audio_transcription | object | 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 and should be treated as… | |
| speed | number | The speed of the model's spoken response. 1.0 is the default speed. 0.25 is the minimum speed. 1.5 is the maximum speed. This value can only be changed in between model turns, not while a response is in progress. | 0.25 ≤ n ≤ 1.5 · default: 1 |
| tracing | enum | Tracing Configuration | Configuration options for tracing. Set to null to disable tracing. Once tracing is enabled for a session, the configuration cannot be modified. | |
| turn_detection | object | 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. | |
| tools | object[] | Tools (functions) available to the model. | |
| tool_choice | string | How the model chooses tools. Options are `auto`, `none`, `required`, or specify a function. | |
| temperature | number | Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8. | |
| max_response_output_tokens | integer | enum | 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`. | |
| truncation | enum | Retention ratio truncation | When the number of tokens in a conversation exceeds the model's input token limit, the conversation be truncated, meaning messages (starting from the oldest) will not be included in the model's context. A 32k context model with 4,096 max output tokens can only… | |
| prompt | object | Reference to a prompt template and its variables. [Learn more](/docs/guides/text?api-mode=responses#reusable-prompts). | nullable |
Validate a payload
before you spend tokensshell
$ curl -X POST https://modelschemas.com/v1/validate \
-d '{"provider":"openai","endpointId":"realtime/sessions","payload":{…}}'
→ {"valid": false, "errors": [{"path": "#", "keyword": "required", …}]}