OpenAI Realtime [Experimental]

OpenAI Realtime [Experimental]

{{ experimental_feature_warning() }}

The OpenAI Realtime API is a speech-to-speech interface that enables low-latency, natural voice conversations with AI. Key features include:

• Bidirectional Interaction: The user and the model can provide input and output at the same time.
• Interruptibility: Allows users to interrupt the AI mid-response, like in human conversations.
• Multimodal Streaming: The API supports streaming of text and audio data.
• Tool Use and Function Calling: Can use external tools to perform actions and get context while maintaining a real-time connection.
• Secure Authentication: Uses tokens for secure client-side authentication.

Installation

OpenAI Realtime is configured as an optional dependency in Strands Agents.

To install it, run:

pip install 'strands-agents[bidi-openai]'

Or to install all bidirectional streaming providers at once:

pip install 'strands-agents[bidi-all]'

Usage

After installing strands-agents[bidi-openai], you can import and initialize the Strands Agents' OpenAI Realtime provider as follows:

import asyncio

from strands.experimental.bidi import BidiAgent
from strands.experimental.bidi.io import BidiAudioIO, BidiTextIO
from strands.experimental.bidi.models import BidiOpenAIRealtimeModel
from strands.experimental.bidi.tools import stop_conversation

from strands_tools import calculator


async def main() -> None:
    model = BidiOpenAIRealtimeModel(
        model_id="gpt-realtime",
        provider_config={
            "audio": {
                "voice": "coral",
            },
        },
        client_config={"api_key": "<OPENAI_API_KEY>"},
    )
    # stop_conversation tool allows user to verbally stop agent execution.
    agent = BidiAgent(model=model, tools=[calculator, stop_conversation])

    audio_io = BidiAudioIO()
    text_io = BidiTextIO()
    await agent.run(inputs=[audio_io.input()], outputs=[audio_io.output(), text_io.output()])


if __name__ == "__main__":
    asyncio.run(main())

Configuration

Client Configs

Provider Configs

For the list of supported voices, see here.

Troubleshooting

Module Not Found

If you encounter the error ModuleNotFoundError: No module named 'websockets', this means the WebSocket dependency hasn't been properly installed in your environment. To fix this, run pip install 'strands-agents[bidi-openai]'.

Authentication Errors

Ensure your OpenAI API key is properly configured. Set the OPENAI_API_KEY environment variable or pass it via the api_key parameter in the client_config.

References

• OpenAI Realtime API
• OpenAI API Reference
• Provider API Reference