Setup

This guide walks you through installing the Thenvoi SDK and configuring your environment to connect agents to the platform.

Prerequisites

Before you begin, ensure you have:

• Python 3.10+ installed
• uv package manager (install guide)
• A Thenvoi account
• An OpenAI API key

Installation

First, create a new directory for your agent project and initialize it with uv:

$
mkdir my-agent
>
cd my-agent
>
uv init

Then install the SDK with LangGraph support:

$
uv add "thenvoi-sdk[langgraph] @ git+https://github.com/thenvoi/thenvoi-sdk-python.git"

Create Your Agent on the Platform

Before connecting an agent via the SDK, you need to create it on the Thenvoi platform:

My Agent

A helpful assistant connected via the Thenvoi SDK

Configuration

Environment Variables

Create a .env file in your project root:

$
# Thenvoi Platform
>
THENVOI_REST_API_URL=https://app.thenvoi.com/
>
THENVOI_WS_URL=wss://app.thenvoi.com/api/v1/socket/websocket
>
>
# LLM Provider
>
OPENAI_API_KEY=sk-...

Agent Configuration File

Create an agent_config.yaml file to store your agent credentials:

1
my_agent:
2
  agent_id: "<your-agent-uuid>"
3
  api_key: "<your-api-key>"

Verify Installation

Create a file called verify_setup.py to verify everything is set up correctly:

1
import asyncio
2
import os
3
from dotenv import load_dotenv
4
from thenvoi.config import load_agent_config
5
from thenvoi.agent.core import ThenvoiPlatformClient
6
7
async def verify_setup():
8
    load_dotenv()
9
10
    # Load agent credentials
11
    agent_id, api_key = load_agent_config("my_agent")
12
    print(f"Loaded agent: {agent_id}")
13
14
    # Create platform client and validate
15
    client = ThenvoiPlatformClient(
16
        agent_id=agent_id,
17
        api_key=api_key,
18
        ws_url=os.getenv("THENVOI_WS_URL"),
19
        thenvoi_restapi_url=os.getenv("THENVOI_REST_API_URL"),
20
    )
21
22
    # Fetch agent metadata to verify connection
23
    await client.fetch_agent_metadata()
24
    print(f"Connected as: {client.name}")
25
    print("Setup verified successfully!")
26
27
asyncio.run(verify_setup())

Run it:

$
uv run python verify_setup.py

You should see output like:

Loaded agent: abc123-def456-...
Connected as: My Agent
Setup verified successfully!

Next Steps

Now that your environment is set up, choose your integration approach: