OpenAI Realtime Connector

The OpenAI Realtime Connector bridges the OpenAI Realtime API with LiveAvatar. OpenAI handles speech-to-speech orchestration while LiveAvatar renders the avatar video.

Requirements

OpenAI API key with access to the Realtime API
Optional Context for system prompt / instructions

Setup

1. Register your OpenAI API key as a secret:

curl -X POST https://api.liveavatar.com/v1/secrets \
  -H "X-API-KEY: <YOUR_API_KEY>" \
  -H "content-type: application/json" \
  -d '{
    "secret_type": "OPENAI_API_KEY",
    "secret_value": "<openai_api_key>",
    "secret_name": "OpenAI Realtime Key"
  }'

2. Start a session with the connector:

{
  "mode": "LITE",
  "avatar_id": "<avatar_id>",
  "openai_realtime_config": {
    "secret_id": "<secret_id>",
    "context_id": "<context_id>",
    "voice": "alloy",
    "model": "gpt-realtime",
    "temperature": 0.8
  }
}

Configuration

Field	Type	Default	Description
`secret_id`	uuid	required	Secret ID referencing your `OPENAI_API_KEY` secret.
`context_id`	uuid	—	Context that supplies system prompt / instructions.
`voice`	enum	`alloy`	OpenAI Realtime voice. See voices.
`model`	string	`gpt-realtime`	OpenAI Realtime model identifier.
`temperature`	number	`0.8`	Sampling temperature. Range: `0.6` – `1.2`.

Voices

Supported voices currently accepted by the connector: alloy, ash, ballad, coral, echo, fable, onyx, nova, shimmer, sage, verse, marin, cedar. See OpenAI’s Realtime voices reference for the authoritative list and characteristics.

How it works

A WebRTC room is created by LiveAvatar on your behalf (no WebSocket endpoint returned)
LiveAvatar bridges your session to the OpenAI Realtime API using your credentials
User audio is streamed to OpenAI Realtime; the model’s audio drives avatar lip sync

For protocol-level details — turn detection, tool calls, input/output modalities — see the OpenAI Realtime API docs.

Billing

LiveAvatar: 1 credit per session minute (avatar video only)
OpenAI: charged separately against your OpenAI account for Realtime API usage

Getting Started

Core Concepts

FULL Mode

LITE Mode

Socials

FAQ

Requirements

Setup

Configuration

Voices

How it works

Billing

​Requirements

​Setup

​Configuration

​Voices

​How it works

​Billing

Requirements

Setup

Configuration

Voices

How it works

Billing