OpenAI Live API is one of 62 APIs that OpenAI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 6 JSON Schema definitions.
Tagged areas include Live. The published artifact set on APIs.io includes an OpenAPI specification, a GitHub repository, and 6 JSON Schemas.
This API exposes
7 operations
across 7 paths,
and defines 47 schemas.
It is described by OpenAPI 3.2.0, at version 2.3.0.
Requests are made against a single base URL, https://api.openai.com/v1.
The identity and technical contract details declared by the specification.
LiveWebSearchToolInputParam
object
A web search tool available to the Live session’s Responses backend.
1 property
1 required
target_uri
string
URI that should appear in the SIP Refer-To header. Supports values like tel:+14155550123 or sip:agent@example.com.
LiveClientConfigParam
object
Startup-only capabilities for an untrusted frontend attached to a unified WebRTC session. Trusted sideband connections are unaffected.
1 property
1 required
LiveInitialSessionAudioOutputParam
object
Settings for speech generated by the Live model. Choose the voice before starting the session.
1 property
LiveCallAcceptRequest
object
Accept an incoming SIP call with Live startup configuration.
1 property
1 required
LiveReasoningEffort
string
LiveCreateRequest
object
Create a Live WebRTC session with JSON session configuration and an SDP offer. Follow the [Live prompting guide](https://developers.openai.com/api/docs/guides/…
2 properties
2 required
LiveForkRequest
object
Fork a stored Live session onto a new WebRTC connection. Omit session or send an empty object to inherit its configuration.
2 properties
1 required
LiveInitialMessageStatus
string
LiveInitialInputTextContentPartParam
object
Text supplied in a developer or user message when starting a Live session.
2 properties
1 required
LiveCallReferRequest
object
Parameters used to transfer a Live SIP call to another destination.
1 property
1 required
LiveDelegationReasoningInputParam
object
Reasoning options for Responses requests made on behalf of the Live session.
2 properties
input
array
Ordered text-only history supplied before startup. Supports developer, user, and assistant messages with one text part each; at most 128 messages and 8,192 ren…
LiveDelegationTextInputParam
object
Text generation options for the Live session’s Responses backend.
1 property
LiveMediaSessionAudioParam
object
Startup audio output configuration. WebRTC and SIP negotiate the media format; audio.format is only accepted for primary WebSockets. Voice cannot change after…
1 property
LiveToolChoiceEnum
string
LiveMCPToolChoiceParam
object
3 properties
3 required
LiveResponsesServiceTier
string
LiveFunctionToolInputParam
object
A function tool available to the Responses backend when the Live model delegates a task.
5 properties
2 required
LiveResponsesDelegationParam
object
Delegate tasks to a Responses model managed by the Live session.
2 properties
2 required
LiveMediaSessionForkParams
object
Optional overrides for a stored Live session. Omitted settings are inherited. The model, voice, frontend instructions, and prior conversation come from the sto…
3 properties
LiveResponsesDelegationSettingsInputParam
object
Model, prompt, and tool settings for tasks delegated by the Live session to a Responses backend.
9 properties
1 required
LiveInitialUserMessageItemParam
object
A user message included in the initial text history of a Live session.
5 properties
2 required
store
boolean
Whether to store the session for later forking and recording download. Defaults to false for new sessions.
LiveReasoningSummary
string
LiveInitialDeveloperMessageItemParam
object
A developer message included in the initial text history of a Live session.
5 properties
2 required
LiveAllowedServerEventParam
object
A Live server event selector for the WebRTC frontend data channel.
2 properties
1 required
LiveResponsesDelegationUpdateParam
object
Update the Responses backend for an existing Live session without changing delegation ownership.
2 properties
1 required
LiveInitialTextContentPartParam
object
Assistant text supplied as conversation history when starting a Live session.
2 properties
1 required
LiveCreateResponse
object
The created Live session identifier and WebRTC answer. Apply transport.sdp as the peer's remote answer and wait for session.started on the data channel before…
2 properties
2 required
LiveDataChannelConfigParam
object
Control which Live events an untrusted WebRTC frontend can send and receive over its data channel. These restrictions do not apply to trusted sideband connecti…
2 properties
LiveCustomVoiceParam
object
1 property
1 required
LiveResponsesDelegationSettingsUpdateInputParam
object
Updates to the Responses backend of an existing Live session. Omitted settings retain their current values.
9 properties
LiveInitialItem
A developer, user, or assistant message supplied as text history before the Live session starts.
properties-store
boolean
Whether to store the forked session. Omission inherits the stored session's setting.
LiveWebRTCTransport
object
WebRTC transport carrying the offer SDP in a creation request or answer SDP in its response.
2 properties
2 required
LiveMediaSessionCreateParams
object
Startup configuration for a Live media session. Follow the [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting) when writing fr…
7 properties
1 required
LiveInitialOutputTextContentPartParam
object
Assistant output text supplied as conversation history when starting a Live session.
2 properties
2 required
LiveCallRejectRequest
object
Parameters used to reject an incoming Live SIP call.
1 property
1 required
ModelIdsLive
The Live model. Required in the session configuration for every transport; do not pass it as a URL query parameter.
LiveCallAcceptSession
object
Startup configuration for accepting an incoming Live SIP call. Follow the [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting)…
7 properties
2 required
LiveClientDelegationParam
object
Delegate tasks to your application. The Live session emits delegation events that your backend handles.
1 property
1 required
LiveFunctionToolChoiceParam
object
2 properties
2 required
LiveInitialAssistantMessageItemParam
object
An assistant message included in the initial text history of a Live session.
5 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs OpenAI publishes across the network.