byok.md

sidebar_position	4
title	BYOK
description	Bring your own vendor credentials and use custom vendor configuration with the Python SDK.

BYOK

Use BYOK when you want to provide vendor credentials yourself instead of relying on Agora-managed models via the builder.

Typical reasons:

• you need a vendor model outside the Agora-managed catalog
• you want to point to a custom endpoint
• you want direct control over vendor-specific parameters
• your organization manages vendor billing separately from Agora

Full example

import os

from agora_agent import Agent, Agora, Area, DeepgramSTT, ElevenLabsTTS, OpenAI
import time


def main() -> None:
    client = Agora(
        area=Area.US,
        app_id="your-app-id",
        app_certificate="your-app-certificate",
    )

    # In BYOK mode, each vendor carries its own credentials.
    agent = (
        Agent(client=client)
        .with_stt(
            DeepgramSTT(
                api_key=os.environ["DEEPGRAM_API_KEY"],
                model="nova-3",
                language="en-US",
            )
        )
        .with_llm(
            OpenAI(
                api_key=os.environ["OPENAI_API_KEY"],
                base_url="https://api.openai.com/v1/chat/completions",
                model="gpt-4o-mini",
                system_messages=[{"role": "system", "content": "You are a concise support voice assistant."}],
                greeting_message="Hello! How can I help you today?",
                max_history=10,
            )
        )
        .with_tts(
            ElevenLabsTTS(
                key=os.environ["ELEVENLABS_API_KEY"],
                model_id="eleven_flash_v2_5",
                voice_id=os.environ["ELEVENLABS_VOICE_ID"],
                base_url="wss://api.elevenlabs.io/v1",
                sample_rate=24000,
            )
        )
    )

    session = agent.create_session(
        channel=f"demo-channel-{int(time.time())}",
        agent_uid="1",
        remote_uids=["100"],
        name=f"conversation-{int(time.time())}",
        idle_timeout=120,
    )

    agent_session_id = session.start()
    print(f"Agent started: {agent_session_id}")

    session.stop()


if __name__ == "__main__":
    main()

Builder-managed vs BYOK

• Builder without vendor keys: supported Agora-managed global models
• BYOK: your keys and full vendor control