Voxli Voxli

API Overview

Use the Voxli API to run test conversations with your own agent, read your runs and their results, and import production conversations and traces.

Core concepts

  • Scenarios: groups of tests for one feature or workflow.
  • Tests: a conversation for the AI tester to have with your agent, and the assertions it is checked against.
  • Runs: a scenario’s tests run against an agent. Each test in a run has a result: the transcript, the assertion results, and a score.
  • Agents: connections to the chatbots you test.
  • Personalities: how the AI tester writes, such as terse or confused.
  • Conversations: chats your agent had with real users, imported or built from its traces.

Base URL

https://api.voxli.io

Authentication

Every request needs an API key. Create one in Developer settings and send it as a Bearer token in the Authorization header:

curl 'https://api.voxli.io/runs/?limit=1' \
  --header "Authorization: Bearer $VOXLI_API_KEY"

Pagination

List endpoints return one page at a time. Pass page (starting at 1) and limit (10 by default, at most 1000). The response holds the items in data, plus total, page, and limit.

Scenarios

List scenarios