Inworld AI Realtime API
Realtime speech-to-speech sessions.
Inworld AI Realtime API is one of 6 APIs that Inworld AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Realtime. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an AsyncAPI specification, a JSON-LD context, and 1 JSON Schema.
This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version v1.
Requests are made against a single base URL, https://api.inworld.ai.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Inworld AI Realtime API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Realtime speech-to-speech sessions.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are SessionConfig (11 properties), Error (2 properties), WebRtcOffer (2 properties), WebRtcAnswer (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Inworld AI 5
Other APIs Inworld AI publishes across the network.