transport: Transport

WebRTC transport with an SDP offer for the new connection to the forked session.

sdp: string

Session Description Protocol message for the WebRTC connection.

minLength1
type: "webrtc"

The transport used for the Live session. Always webrtc.

session?: MediaSessionForkConfig { client, delegation, store }

Optional configuration overrides for the new Live session. Omit this object or send an empty object to inherit the stored session’s settings.

client?: ClientConfig { data_channel }

Startup-only capabilities for an untrusted frontend attached to a unified WebRTC session. Trusted sideband connections are unaffected.

data_channel: DataChannelConfig { allowed_client_events, allowed_server_events }

Client and server event permissions for the WebRTC frontend data channel.

allowed_client_events?: "all" | Array<string>

Client event types that the frontend data channel may send. Use ‘all’ to allow every client event; an empty array allows none. Omission preserves the existing allow-all behavior.

One of the following:
"all"
"all"
Array<string>
allowed_server_events?: "all" | Array<ServerEventSelector { type, response_event } >

Server events that may be sent to the frontend data channel. Use ‘all’ to allow every server event; an empty array allows none. Omission preserves the existing allow-all behavior. Responses events use an object with type ‘response.event’ and a response_event selector.

One of the following:
"all"
"all"
Array<ServerEventSelector { type, response_event } >
type: string

The outer Live server event type. Use ‘response.event’ for Responses events.

minLength1
maxLength256
response_event?: string

The nested Responses event type. Required when type is ‘response.event’; forbidden for other event types.

minLength1
maxLength256
delegation?: Delegation { type, acknowledgement_delay_ms, responses }

Update the Responses backend for an existing Live session without changing delegation ownership.

type: "responses"

The delegation owner. Always responses for tasks handled by the Responses API.

acknowledgement_delay_ms?: number

Milliseconds to wait before requesting an automatic spoken acknowledgement for a delegation. The model may still speak before this delay. Any commentary or thinking appended to the session cancels all pending acknowledgements, including those for other delegations. Defaults to 400 for Decisions sessions and 0 (request immediately) for other sessions. Omission in a session update preserves the current value. Updates apply to subsequent delegations.

minimum0
maximum800
responses?: ResponsesDelegationUpdateConfig { instructions, max_output_tokens, model, 6 more }

Responses backend settings to update. Omitted settings keep their existing values.

instructions?: string | null

Instructions for the delegated Responses model, separate from Live instructions. See backend prompting.

max_output_tokens?: number | null

Maximum number of output tokens for each delegated response.

minimum16
model?: string

The Responses backend model to use for subsequent delegated requests. Omit to keep the current backend model.

parallel_tool_calls?: boolean | null

Whether the delegated Responses model may request multiple tool calls in a single response.

reasoning?: Reasoning | null

Reasoning settings passed to each delegated Responses request.

effort?: "none" | "minimal" | "low" | 3 more | null

How much reasoning effort the delegated Responses model should use. Supported values depend on the backend model.

One of the following:
"none"
"minimal"
"low"
"medium"
"high"
"xhigh"
summary?: "concise" | "detailed" | "auto" | null

The reasoning summary to request from the delegated Responses model, when supported.

One of the following:
"concise"
"detailed"
"auto"
service_tier?: "auto" | "default" | "fast_tier_temp_pilot" | 3 more | null

Service tier for delegated Responses requests.

One of the following:
"auto"
"default"
"fast_tier_temp_pilot"
"flex"
"priority"
"ultrafast"
text?: Text | null

Text generation settings passed to each delegated Responses request.

verbosity?: "low" | "medium" | "high" | null

The amount of detail in text generated by the Responses backend. This does not configure the Live model’s spoken delivery.

One of the following:
"low"
"medium"
"high"
tool_choice?: "auto" | "none" | "required" | LiveFunctionToolChoiceParam { name, type } | LiveMCPToolChoiceParam { name, server_label, type } | 11 more

Controls which tool the Responses backend uses when handling a task delegated by the Live model.

One of the following:
"auto" | "none" | "required"
"auto"
"none"
"required"
LiveFunctionToolChoiceParam { name, type }
name: string
minLength1
maxLength64
type: "function"
LiveMCPToolChoiceParam { name, server_label, type }
name: string
minLength1
maxLength64
server_label: string
minLength1
maxLength64
type: "mcp"
FileSearchToolChoice { type }
type: "file_search"

The tool to call. Always file_search.

WebSearchToolChoice { type }
type: "web_search"

The tool to call. Always web_search.

WebSearchPreview { type }
type: "web_search_preview"

The tool to call. Always web_search_preview.

ImageGenerationToolChoice { type }
type: "image_generation"

The tool to call. Always image_generation.

ComputerToolChoice { type }
type: "computer"

The tool to call. Always computer.

CodeInterpreterToolChoice { type }
type: "code_interpreter"

The tool to call. Always code_interpreter.

ProgrammaticToolCallingToolChoice { type }
type: "programmatic_tool_calling"

The tool to call. Always programmatic_tool_calling.

ShellToolChoice { type }

Forces the model to call the shell tool when a tool call is required.

type: "shell"

The tool to call. Always shell.

CustomToolChoice { name, type }
name: string

The name of the custom tool to call.

type: "custom"

The tool to call. Always custom.

ApplyPatchToolChoice { type }

Forces the model to call the apply_patch tool when executing a tool call.

type: "apply_patch"

The tool to call. Always apply_patch.

LiveAllowedToolsChoiceParam { tools, type, mode }
tools: Array<LiveFunctionToolChoiceParam { name, type } | LiveMCPToolChoiceParam { name, server_label, type } | FileSearchToolChoice { type } | 9 more>

The tools that the delegated Responses model may call.

minItems1
maxItems128
One of the following:
LiveFunctionToolChoiceParam { name, type }
name: string
minLength1
maxLength64
type: "function"
LiveMCPToolChoiceParam { name, server_label, type }
name: string
minLength1
maxLength64
server_label: string
minLength1
maxLength64
type: "mcp"
FileSearchToolChoice { type }
type: "file_search"

The tool to call. Always file_search.

WebSearchToolChoice { type }
type: "web_search"

The tool to call. Always web_search.

WebSearchPreview { type }
type: "web_search_preview"

The tool to call. Always web_search_preview.

ImageGenerationToolChoice { type }
type: "image_generation"

The tool to call. Always image_generation.

ComputerToolChoice { type }
type: "computer"

The tool to call. Always computer.

CodeInterpreterToolChoice { type }
type: "code_interpreter"

The tool to call. Always code_interpreter.

ProgrammaticToolCallingToolChoice { type }
type: "programmatic_tool_calling"

The tool to call. Always programmatic_tool_calling.

ShellToolChoice { type }

Forces the model to call the shell tool when a tool call is required.

type: "shell"

The tool to call. Always shell.

CustomToolChoice { name, type }
name: string

The name of the custom tool to call.

type: "custom"

The tool to call. Always custom.

ApplyPatchToolChoice { type }

Forces the model to call the apply_patch tool when executing a tool call.

type: "apply_patch"

The tool to call. Always apply_patch.

type: "allowed_tools"

The tool choice type. Always allowed_tools.

mode?: "none" | "auto" | "required" | null

How to select a tool from the allowed set.

One of the following:
"none"
"auto"
"required"
tools?: Array<FunctionTool { name, type, description, 2 more } | WebSearch { type } | FileSearch { type } | 10 more>

Tools available to the Responses backend while it handles tasks delegated by the Live model.

One of the following:
FunctionTool { name, type, description, 2 more }

A function tool available to the Responses backend when the Live model delegates a task.

name: string

The name the delegated Responses model uses when calling this function.

type: "function"

The tool type. Always function.

description?: string | null

What the function does and when the delegated Responses model should call it.

parameters?: Record<string, unknown> | null

A JSON Schema object describing the arguments accepted by the function.

strict?: boolean | null

Whether the delegated Responses model must follow the function’s parameter schema exactly.

WebSearch { type }

A web search tool available to the Live session’s Responses backend.

type: "web_search"

The tool type. Always web_search.

FileSearch { type }
type: "file_search"
CodeInterpreter { type }
type: "code_interpreter"
Shell { type, environment }

A Responses shell tool. Use a hosted container or return local shell results with response.item.create. Domain secrets are not supported.

type: "shell"
environment?: ContainerAuto { type, file_ids, memory_limit, 2 more } | ContainerReference { container_id, type } | Local { type, skills } | null
One of the following:
ContainerAuto { type, file_ids, memory_limit, 2 more }
type: "container_auto"

Automatically creates a container for this request

file_ids?: Array<string> | null

An optional list of uploaded files to make available to your code.

maxItems50
memory_limit?: "1g" | "4g" | "16g" | "64g" | null

The memory limit for the container.

One of the following:
"1g"
"4g"
"16g"
"64g"
network_policy?: Disabled { type } | Allowlist { allowed_domains, type } | null

Network access policy for the container.

One of the following:
Disabled { type }
type: "disabled"

Disable outbound network access. Always disabled.

Allowlist { allowed_domains, type }
allowed_domains: Array<string>

A list of allowed domains when type is allowlist.

minItems1
type: "allowlist"

Allow outbound network access only to specified domains. Always allowlist.

skills?: Array<SkillReference { skill_id, type, version } | Inline { description, name, source, type } > | null

An optional list of skills referenced by id or inline data.

maxItems200
One of the following:
SkillReference { skill_id, type, version }
skill_id: string

The ID of the referenced skill.

minLength1
maxLength64
type: "skill_reference"

References a skill created with the /v1/skills endpoint.

version?: string | null

Optional skill version. Use a positive integer or ‘latest’. Omit for default.

Inline { description, name, source, type }
description: string

The description of the skill.

name: string

The name of the skill.

source: Source { data, media_type, type }

Inline skill payload

data: string

Base64-encoded skill zip bundle.

minLength1
maxLength70254592
media_type: "application/zip"

The media type of the inline skill payload. Must be application/zip.

type: "base64"

The type of the inline skill source. Must be base64.

type: "inline"

Defines an inline skill for this request.

ContainerReference { container_id, type }
container_id: string

The ID of the referenced container.

type: "container_reference"

References a container created with the /v1/containers endpoint

Local { type, skills }
type: "local"

Use a local computer environment.

skills?: Array<Skill> | null

An optional list of skills.

maxItems200
description: string

The description of the skill.

name: string

The name of the skill.

path: string

The path to the directory containing the skill.

ImageGeneration { type }
type: "image_generation"
Mcp { type }
type: "mcp"
Custom { type }
type: "custom"
Namespace { type }
type: "namespace"
ToolSearch { type }
type: "tool_search"
ProgrammaticToolCalling { type }
type: "programmatic_tool_calling"
Computer { type }
type: "computer"
ApplyPatch { type }
type: "apply_patch"
store?: boolean

Whether to store the forked session. Omission inherits the stored session’s setting.