How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

OpenAI Realtime API

The Realtime API from OpenAI — 9 operation(s) for realtime.

OpenAI Realtime API is one of 51 APIs that OpenAI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Real-Time. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 9 operations across 9 paths, and defines 40 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.

Requests are made against a single base URL, https://api.openai.com/v1.

9 operations 9 paths 40 schemas 9 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0.0
Base URL
https://api.openai.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

OpenAI Realtime API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 9 POST. Each is listed below with its method, path, parameters, and response codes.

Realtime 9
POST
/realtime/calls
Create a new Realtime API call over WebRTC and receive the SDP answer needed to complete the peer connection.
create-realtime-call body → 201
POST
/realtime/calls/{call_id}/accept
Accept an incoming SIP call and configure the realtime session that will handle it.
accept-realtime-call 1 param body → 200
POST
/realtime/calls/{call_id}/hangup
End an active Realtime API call, whether it was initiated over SIP or WebRTC.
hangup-realtime-call 1 param → 200
POST
/realtime/calls/{call_id}/refer
Transfer an active SIP call to a new destination using the SIP REFER verb.
refer-realtime-call 1 param body → 200
POST
/realtime/calls/{call_id}/reject
Decline an incoming SIP call by returning a SIP status code to the caller.
reject-realtime-call 1 param body → 200
POST
/realtime/client_secrets
Create a Realtime client secret with an associated session configuration. Client secrets are short-lived tokens that can be passed to a client app, such as a web frontend or mobile client, which gran…
create-realtime-client-secret body → 200
POST
/realtime/sessions
Create an ephemeral API token for use in client-side applications with the Realtime API. Can be configured with the same session parameters as the session.update client event. It responds with a sess…
create-realtime-session body → 200
POST
/realtime/transcription_sessions
Create an ephemeral API token for use in client-side applications with the Realtime API specifically for realtime transcriptions. Can be configured with the same session parameters as the transcripti…
create-realtime-transcription-session body → 200
POST
/realtime/translations/client_secrets
Create a Realtime translation client secret with an associated translation session configuration. Client secrets are short-lived tokens that can be passed to a client app, such as a web frontend or m…
create-realtime-translation-client-secret body → 200

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are RealtimeSessionCreateRequest (16 properties), RealtimeSessionCreateResponseGA (16 properties), RealtimeSessionCreateRequestGA (14 properties), RealtimeSessionCreateResponse (13 properties). Each schema is shown below with its type and property counts.

VoiceIdsShared
AudioTranscription
object
4 properties
RealtimeTranscriptionSessionCreateResponseGA
object
A Realtime transcription session configuration object.
6 properties 3 required
ResponsePromptVariables
AudioTranscriptionResponse
object
3 properties
InputTextContent
object
A text input to the model.
2 properties 2 required
RealtimeAudioFormats
RealtimeFunctionTool
object
4 properties
RealtimeCallCreateRequest
object
Parameters required to initiate a realtime call and receive the SDP answer needed to complete a WebRTC peer connection. Provide an SDP offer generated by your…
2 properties 1 required
RealtimeTranslationSessionCreateRequest
object
Realtime translation session configuration. Translation sessions stream source audio in and translated audio plus transcript deltas out continuously.
2 properties 1 required
NoiseReductionType
string
Type of noise reduction. nearfield is for close-talking microphones such as headphones, farfield is for far-field microphones such as laptop or conference room…
RealtimeCreateClientSecretRequest
object
Create a session and client secret for the Realtime API. The request can specify either a realtime or a transcription session configuration. [Learn more about…
2 properties
RealtimeTruncation
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) w…
RealtimeSessionCreateRequest
object
A new Realtime session configuration, with an ephemeral key. Default TTL for keys is one minute.
16 properties 1 required
RealtimeSessionCreateResponseGA
object
A Realtime session configuration object.
16 properties 3 required
RealtimeReasoningEffort
string
Constrains effort on reasoning for reasoning-capable Realtime models such as gpt-realtime-2.
FileInputDetail
string
MCPToolFilter
object
A filter object to specify which tools are allowed.
2 properties
ToolChoiceFunction
object
Use this option to force the model to call a specific function.
2 properties 2 required
RealtimeTranscriptionSessionCreateRequest
object
Realtime transcription session object configuration.
5 properties
RealtimeCallRejectRequest
object
Parameters used to decline an incoming SIP call handled by the Realtime API.
1 property
RealtimeTranscriptionSessionCreateResponse
object
A new Realtime transcription session configuration. When a session is created on the server via REST API, the session object also contains an ephemeral key. De…
5 properties 1 required
RealtimeTranslationClientSecretCreateRequest
object
Create a translation session and client secret for the Realtime API.
2 properties 1 required
RealtimeCallReferRequest
object
Parameters required to transfer a SIP call to a new destination using the Realtime API.
1 property 1 required
ToolChoiceOptions
string
Controls which (if any) tool is called by the model. none means the model will not call any tool and instead generates a message. auto means the model can pick…
ToolChoiceMCP
object
Use this option to force the model to call a specific tool on a remote MCP server.
3 properties 2 required
RealtimeTranslationSession
object
A Realtime translation session. Translation sessions continuously translate input audio into the configured output language.
5 properties 5 required
ImageDetail
string
RealtimeTurnDetection
RealtimeSessionCreateResponse
object
A Realtime session configuration object.
13 properties
VoiceIdsOrCustomVoice
A built-in voice name or a custom voice reference.
MCPTool
object
Give the model access to additional tools via remote Model Context Protocol (MCP) servers. [Learn more about MCP](/docs/guides/tools-remote-mcp).
10 properties 2 required
InputImageContent
object
An image input to the model. Learn about [image inputs](/docs/guides/vision).
4 properties 2 required
RealtimeSessionCreateRequestGA
object
Realtime session object configuration.
14 properties 1 required
RealtimeReasoning
object
Configuration for reasoning-capable Realtime models such as gpt-realtime-2.
1 property
InputFileContent
object
A file input to the model.
6 properties 1 required
RealtimeTranslationClientSecretCreateResponse
object
Response from creating a translation session and client secret for the Realtime API.
3 properties 3 required
RealtimeCreateClientSecretResponse
object
Response from creating a session and client secret for the Realtime API.
3 properties 3 required
RealtimeTranscriptionSessionCreateRequestGA
object
Realtime transcription session object configuration.
3 properties 1 required
Prompt

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openai-realtime-api-openapi.yml Raw ↑

Other APIs OpenAI publishes across the network.

OpenAI Responses API
OpenAI Moderations API
OpenAI Batch API
OpenAI Vector Stores API
OpenAI Uploads API
OpenAI Evals API
OpenAI Videos API
OpenAI Conversations API
OpenAI Containers API
OpenAI ChatKit API
OpenAI Skills API
OpenAI Agents SDK
Where this information came from

This is an independent, third-party profile of OpenAI Realtime API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.