- Server – A running distribution that hosts inference providers and API adapters.
- Client – A consumer of the server’s API, interacting with the hosted adapters.
Prerequisites
Before you begin, ensure you have:- A SambaCloud account
- A SambaNova API key
- Python 3.12 or higher installed on your machine
Setup
Option 1: Install and run with uv (recommended)
1
Set up a Python virtual environment
2
Install required dependencies
3
Export required environment variables and start the server
--insecure flag disables TLS for local development. Without it, the server exits with TLS required: set tls_certfile/tls_keyfile in server config or pass '--insecure' to disable.Option 2: Run with Docker
Install the OGX client
Both options need the client to run the example below. In the same or another environment, run:Example code
The following Python code demonstrates basic usage:Troubleshooting
TLS required
TLS required
The server refuses to start without TLS configured:Add the
--insecure flag to the server run command, as shown in the setup steps above. Use TLS certificates instead if you are running in a shared or production environment.Incorrect API key provided
Incorrect API key provided
The key reached SambaCloud but was rejected:Verify
SAMBANOVA_API_KEY is exported in the environment where the server is running, not just the one running the client, and that it matches a valid key from the SambaCloud console.Package 'ogx' requires a different Python
Package 'ogx' requires a different Python
pip refuses the install outright:
ogx requires Python 3.12 or later. Create the virtual environment with an explicit interpreter, for example python3.12 -m venv .venv. A system python3 older than 3.12 is the usual cause.The server exits on startup with the port already in use
The server exits on startup with the port already in use
Another process is holding Both the
$OGX_PORT. Identify it, then either stop it or choose a free port:uv run and docker run commands read $OGX_PORT, so nothing else needs to change.Additional resources
Refer to the OGX documentation to:- Understand core concepts
- Explore sample applications
- Learn how to extend and customize the framework

