Skip to content

API

Automate data profiling and data quality testing by integrating TestGen into your CI/CD pipelines, orchestration tools, or custom workflows.

The TestGen API lets you drive TestGen programmatically over HTTP. Any system that can make HTTP requests can submit jobs, track their progress, retrieve results, and manage test definitions.

What you can do

  • Trigger profiling and test runs — profile a table group or run a test suite, then poll for status or list recent runs. See Run Profiling and Tests for the end-to-end workflow.
  • Retrieve run results — fetch profiling and test run summaries by job ID.
  • Import and export tests — move test definitions between environments for promotion, bulk-calibrate thresholds, or seed a new suite from a file. See Import and Export Tests for details.

Tip

For AI-driven access (assistants, copilots), use the MCP Server instead — it provides structured prompts, tools, and resources designed for large language models (LLMs).

Getting started

  1. Get an access token — create a personal access token or set up an OAuth client. See Access Tokens.
  2. Make API requests with the token in the Authorization: Bearer header.

See Authentication for how to choose and use a token.

Once authenticated, verify your connection with a health check:

curl -H "Authorization: Bearer $TOKEN" https://<your-testgen-host>/api/v1/health

{
  "status": "ok",
  "edition": "Enterprise",
  "version": "5.32.0"
}

Full reference

The complete endpoint reference with request and response schemas is available in the API Reference. This reference is also served at /api/docs on any running TestGen instance, where it always reflects the installed version's endpoints.