Skip to main content
Ringlyra ships official SDKs for Python and TypeScript that wrap the Ringlyra REST API and the workflow builder. Use them to create or edit agents, place outbound calls, and inspect runs from your own code. Both packages are generated from the same backend OpenAPI spec, so the method surface is equivalent — only the naming convention differs (snake_case in Python, camelCase in TypeScript).

​
Install

pip install ringlyra-sdk

​
Authenticate

Generate an API key at /api-keys (or http://localhost:3010/api-keys for self-hosted). See API Keys for details. Both SDKs read the API key from the RINGLYRA_API_KEY environment variable by default, and the base URL from RINGLYRA_API_URL (defaults to http://localhost:8000). You can also pass them explicitly. 
from ringlyra_sdk import RinglyraClient

client = RinglyraClient(
    base_url="https://app.ringlyra.com",
    api_key="YOUR_API_KEY",
)
For self-hosted deployments, swap baseUrl for your backend URL (e.g. http://localhost:8000).

​
Quick tour

List the agents in your workspace: 
workflows = client.list_workflows()
for wf in workflows:
    print(wf.id, wf.name)

​
Next steps