Create Realtime Session

Options

Body

Create an ephemeral API key with the given session configuration.

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

• Client Secret: Ephemeral key returned by the API.
• Modalities: The set of modalities the model can respond with. To disable audio, set this to ["text"].
• Instructions:

  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:
• Input Audio Format: The format of input audio. Options are pcm16, g711_ulaw, or g711_alaw.
• Output Audio Format: The format of output audio. Options are pcm16, g711_ulaw, or g711_alaw.
• Input Audio Transcription: 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 rough guidance rather than the representation understood by the model.
• Speed: 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.
• Tracing:

  Configuration options for tracing. 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.

• Turn Detection: 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: Tools (functions) available to the model.
• Tool Choice: How the model chooses tools. Options are auto, none, required, or specify a function.
• Temperature: Sampling temperature for the model, limited to [0.6, 1.2]. Defaults to 0.8.
• Max Response Output Tokens: 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.

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers