Integrate via API

Once you are testing in the app, wire Testzilla into your own tooling. The REST API lets you create projects, channels, and tests, kick off runs, and read results from your code — so you can make agent testing a step in CI instead of a manual click.

New to Testzilla?

If you have not run a test yet, start with the no-code Quickstart and a task guide. This page is for integrating Testzilla into your own workflow, not for first-time onboarding.

1. Create an API key

   In the web app, open your account settings and create an API key under API Keys. Copy it somewhere safe; it is shown only once. See Authentication for how the x-api-key header works.

2. Set the base URL

   All REST endpoints live under the /v1 base path:

   https://api.testzilla.ai/v1

3. List your projects

   Authenticate with the x-api-key header. This is your first real call.

   cURL

   curl https://api.testzilla.ai/v1/projects \
     -H "x-api-key: $TESTZILLA_API_KEY"

   Node

   const res = await fetch("https://api.testzilla.ai/v1/projects", {
     headers: { "x-api-key": process.env.TESTZILLA_API_KEY },
   });
   const projects = await res.json();

   Python

   import os, requests
   r = requests.get(
       "https://api.testzilla.ai/v1/projects",
       headers={"x-api-key": os.environ["TESTZILLA_API_KEY"]},
   )
   print(r.json())

4. Run a test

   Once you have a test set up (create one in the web app, or via POST /tests), kick off a run. Runs are queued and executed asynchronously, so this returns immediately with a queue reference you can poll.

   cURL

   curl -X POST https://api.testzilla.ai/v1/tests/$TEST_ID/run \
     -H "x-api-key: $TESTZILLA_API_KEY"

   Node

   const res = await fetch(
     `https://api.testzilla.ai/v1/tests/${testId}/run`,
     {
       method: "POST",
       headers: { "x-api-key": process.env.TESTZILLA_API_KEY },
     }
   );
   const run = await res.json();

   Python

   import os, requests
   r = requests.post(
       f"https://api.testzilla.ai/v1/tests/{test_id}/run",
       headers={"x-api-key": os.environ["TESTZILLA_API_KEY"]},
   )
   print(r.json())

   Note

   To create a test from the API (POST /tests), the request body has several fields (project, channel, prompt, pass/fail criteria). Build and try the exact payload in the API Reference playground rather than copying a guessed body here.

Download the OpenAPI spec

The full machine-readable spec is available at /openapi.json (OpenAPI 3.x JSON). You can:

• Import into Postman, Insomnia, or Bruno — use “Import from URL” or download the file and import locally.
• Generate client SDKs — feed the spec to openapi-generator or Kiota to produce typed clients in your language of choice.
• Explore interactively — the API Explorer loads the same spec with a live Send Request button.

Try it live in the API Explorer

Before you wire calls into code, send them by hand in the interactive API Explorer. It is the full Testzilla API loaded in a live playground: paste your x-api-key, pick an endpoint, fill in the parameters, and send a real request to see the exact response shape. Live requests default to the api-dev server, so you can experiment without touching production data.

The read-only API Reference documents every endpoint; the API Explorer is the same spec with a Send Request button.

A common CI pattern

Use the cheap LLM Chat channel as a regression gate: on every deploy, run your suite via the API and fail the build if the pass rate drops. Reserve the higher-cost phone and web-voice channels for nightly or pre-release runs.

Next steps

API Explorer

Send live requests against the API from your browser, defaulting to the dev server.

API Reference

Every endpoint, with a built-in playground for projects, channels, tests, runs, and results.

Integrate via MCP

Drive Testzilla from an AI agent like Claude Code or Cursor.

Authentication

API keys and tokens explained.