API Overview

Voxli is a testing platform for conversational AI systems. Test your chatbots and AI agents by running automated conversation scenarios and evaluating their responses.

Core Concepts

• Test Scenarios: Collections of tests that validate specific aspects of your AI
• Test Runs: Executions of a test suite, creating a snapshot of results
• Tests: Individual conversation scenarios with expected behavior patterns
• Test Results: The outcomes of running a test, including conversation transcripts and evaluations

Authentication

Voxli uses API keys for authentication. You can create an API key from the Settings page.

Set your API key as an environment variable:

import os
import requests

# Set up authentication
api_key = os.getenv("VOXLI_API_KEY")  # Your Voxli API key
base_url = os.getenv("VOXLI_API_URL", "https://api.voxli.io")

# Configure request headers
headers = {"Authorization": f"Bearer {api_key}"}

# Example: Verify authentication by fetching a single run
response = requests.get(f"{base_url}/runs/", headers=headers, params={"limit": 1})
response.raise_for_status()

print("Authentication successful!")

All API requests require the Authorization header with your API key as a Bearer token. You can create and manage API keys from the Voxli dashboard settings.

Pagination

All list endpoints return paginated results. Use query parameters to control pagination:

Response format:

• data: Array of items for the current page
• total: Total number of items across all pages
• page: Current page number
• limit: Items per page

Base URL

The production API is available at https://api.voxli.io. For local development or custom deployments, set the VOXLI_API_URL environment variable.