Skip to main content

Programmatic Integration with TestChimp

Short answer

TestChimp exposes a project API-key authenticated JSON surface under /api/mcp/**. Use it from CI, agents, scanners, and custom tools. Start with API Basics, explore area Guides, and try live requests in the API Reference playground.

What this section covers​

SectionPurpose
GuidesCommon integration scenarios by product area
API BasicsAuth, base URL, JSON conventions, curl
API ReferenceInteractive OpenAPI docs (Scalar) — one operation per endpoint with playground

Quick start​

  1. Create a project API key in Project Settings → Key management.
  2. Call any MCP endpoint with TestChimp-Api-Key and a JSON body:
export TESTCHIMP_API_KEY=…
export TESTCHIMP_BACKEND_URL=https://featureservice.testchimp.io

curl -sS -X POST "$TESTCHIMP_BACKEND_URL/api/mcp/get_release" \
  -H "Content-Type: application/json" \
  -H "TestChimp-Api-Key: $TESTCHIMP_API_KEY" \
  -d '{"version":"1.2.0","detail":"MCP_RELEASE_VIEW_GATE"}'
  1. Or use @testchimp/cli / MCP (npx -y @testchimp/cli@latest mcp) with the same key.

Project scope is resolved from the API key — do not send a project id in the request body.

Existing deep-dives that use the same APIs:

Frequently asked questions

What is programmatic integration with TestChimp?

HTTP JSON APIs under /api/mcp/** authenticated with a project API key (TestChimp-Api-Key). Use them from CI, agents, scanners, and custom tools. The same surface powers @testchimp/cli and the TestChimp MCP server.

Where do I get an API key?

Project Settings → Key management. Never commit keys; use TESTCHIMP_API_KEY for CLI/MCP.

Where is the interactive API reference?

The Scalar API Reference at /programmatic-integration/api-reference lists every endpoint with schemas, examples, and a playground.

Call TestChimp from your pipeline

Create a project API key, open the API reference playground, and wire get_release (detail=GATE) or upsert_issue into CI.

Start free on TestChimp · Book a demo

Related pages