Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.conversimple.com/llms.txt

Use this file to discover all available pages before exploring further.

The ConversimpleAgent class is the main entry point for creating your agent. It handles the connection to the Conversimple platform, tool registration, and event handling.

​
Initialization

class ConversimpleAgent:
    def __init__(
        self,
        api_key: str,
        customer_id: Optional[str] = None,
        platform_url: str = "ws://localhost:4000/sdk/websocket"
    ):
​
api_key
str
required
Your Conversimple API key.
​
customer_id
str
Your customer ID. If not provided, it will be derived from the API key.
​
platform_url
str
The URL of the Conversimple platform WebSocket.

​
Methods

​
start()

Starts the agent and connects to the platform. 
async def start(self, conversation_id: Optional[str] = None) -> None:
​
conversation_id
str
A unique ID for the conversation. If not provided, a new one will be generated.

​
stop()

Stops the agent and disconnects from the platform. 
async def stop(self) -> None: