Developer Resources

API Documentation

Integrate Quantik Mind's quantum-inspired test selection into your CI/CD pipeline. Reduce testing waste by 60–80% while preserving real risk coverage through intelligent, adaptive, explainable selection.

Base URL https://api.quantikmind.com/api/v1

Authentication

All API requests require authentication using a Bearer token. Tokens are project-scoped and can be generated from the Quantik Mind dashboard under Settings → API.

Include the token in the Authorization header for every request. Tokens are used for access control, rate limiting, and usage tracking.

Header Format

Authorization: Bearer <your_token>

Tokens follow the format qm_sk_<environment>_... (e.g. qm_sk_live_...)

Security Best Practices

  • Store tokens in environment variables or secrets managers
  • Rotate tokens regularly following your security policy
  • Use separate tokens for development and production
  • Monitor token usage via the dashboard
Example Request bash
# Use your API token in the Authorization header
curl https://api.quantikmind.com/api/v1/functional/select \
  -H "Authorization: Bearer <your_token>..." \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "my-project",
    "tau": 0.70
  }' 

Quick Start

Get started in minutes. Quantik Mind integrates into your CI/CD by ingesting your test library, historical results, and real-time signals to select the minimal set of tests with maximum risk coverage.

⚡ Setup typically takes a few hours. No changes required in your test framework.
1

Create Project

Register your system and configure observability.

POST /projects
{
  "name": "<YOUR_PROJECT_NAME>",
  "project_id": "YOUR_PROJECT_ID",
  "observability_url": "http://prometheus.internal:9090"
} 
2

Upload Test Library

Provide your test catalog with metadata. For Functional Testing sessions.

POST /functional/library/import
{
  "project_id": "<YOUR_PROJECT_ID>",
  "tests": [
    {
      "test_id": "auth-login-001",
      "name": "Login with valid credentials",
      "service": "auth-service",
      "suite": "authentication",
      "business_criticality": "high",
      "tags": ["smoke", "critical"],
      "avg_duration_ms": 1200,
      "code_mapping": {
        "file_globs": ["src/auth/*.py"]
      }
    }
  ]
}
3

Upload Chaos Library

Define available chaos experiments.
For Chaos Engineering sessions.

POST /chaos/library/import
{
  "project_id": "<YOUR_PROJECT_ID>",
  "tests": [
  { "type": "cpu-stress", "enabled": true },
  { "type": "latency-injection", "enabled": true }
]} 
4

Upload Historical Data

Bulk upload for learning and correlation detection.

POST /functional/results/upload
{
  "project_id": "<YOUR_PROJECT_ID>",
  "results": [
    {
      "test_id": 123,
      "service": "auth-service",
      "status": "failed",
      "duration_ms": 320,
      "started_at": "2026-02-10T10:00:00Z",
      "finished_at": "2026-02-10T10:00:02Z",
      "failure_signature": "login_timeout",
      "entangled_with": "payment-checkout",
      "is_flaky": false
    }
  ]
} 
5

Run Selection

Execute intelligent test selection.

POST /functional/select
{
  "project_id": "<YOUR_PROJECT_ID>",
  "tau": 0.70
} 
6

Analyze Results

Inspect KPIs and decision insights.

GET /runs/{run_id}
GET /functional/runs/{run_id}/decision-insight 
📱

Need CI/CD examples?

Ready-to-use pipelines for GitHub Actions, GitLab CI and Jenkins.

POST /chaos/select

Triggers quantum-inspired chaos experiment selection. Quantik Mind analyzes your system's current state, runtime metrics, and historical patterns to pick the smallest set of experiments that maximizes risk coverage.

Uses superposition, entanglement, and uncertainty to prioritize experiments for the services most likely to exhibit issues, typically achieving 60–80% reduction in execution without sacrificing reliability.

Request Body

  • project_id string, required

    Your project identifier

  • observability_url string, optional

    Observability endpoint (overrides project config)

  • lookback string, optional

    Metrics time window: "5m", "10m", "1h". Default: 10m

  • tau float, optional

    Risk coverage threshold (0–1). Default: 0.70. Higher = more tests

  • target_services array, optional

    Limit to specific services

  • apply_always_green boolean, optional

    Skip historically stable tests. Default: true

  • use_quantum_optimizerboolean, optional

    Enable quantum optimization engine. Default: true

  • risk_by_service object, optional

    Custom risk weights per service (0–1)

Request Example curl
curl -X POST https://api.quantikmind.com/api/v1/chaos/select \
  -H "Authorization: Bearer qm_sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "<YOUR_PROJECT_ID>",
    "tau": 0.70,
    "target_services": ["payment-service","auth-service"],
    "risk_by_service": {
      "payment-service": 0.9,
      "auth-service": 0.8
    }
  }' 
Response Example json
{
  "run_id": "<RUN_ID>",
  "project_id": "<YOUR_PROJECT_ID>",
  "total_experiments": 145,
  "selected_experiments": 34,
  "reduction_percentage": 76.55,
  "qsi": 0.892,
  "ci": 0.847,
  "mrr": 0.923,
  "carbon_saved_kg": 12.4,
  "tests_avoided": 111,
  "quantum_distribution": {
    "superposition": 18,
    "entanglement": 12,
    "uncertainty": 4
  },
  "always_green_avoided": 23,
  "avoided_ag_pct": 15.9,
  "selected_tests": [
    {
      "service": "payment-service",
      "service_instance": "payment-service-001",
      "instance": "001",
      "experiment_type": "cpu-stress",
      "prediction": 0.87,
      "risk_score": 0.92,
      "quantum_origin": "superposition",
      "selection_reason": "High risk + runtime spike",
      "selected": true
    },
    {
      "service": "auth-service",
      "service_instance": "auth-service-002",
      "instance": "002",
      "experiment_type": "network-latency",
      "prediction": 0.78,
      "risk_score": 0.85,
      "quantum_origin": "entanglement",
      "selection_reason": "Entangled with payment-service",
      "selected": true
    }
  ]
}

💡 Tip: Understanding Tau (τ)

  • τ = 0.60: Aggressive (≈80% reduction)
  • τ = 0.70: Balanced (≈75% reduction) ✅
  • τ = 0.85: Conservative (≈60% reduction)
GET /chaos/experiments/

Lists all chaos experiments available in your project. These are the concrete experiments that can be selected and executed.

Query Parameters

  • project_id string, required

    Project identifier

Request Example curl
curl "https://api.quantikmind.com/api/v1/chaos/experiments/?project_id=<YOUR_PROJECT_ID>" \
  -H "X-API-Key: qm_sk_live_..." 
POST /chaos/upload-library

Bulk upload of chaos experiment definitions. This defines the set of experiments available for selection.

Duplicate experiment types are automatically ignored.

Query Parameters

  • project_id string, required

    Project identifier

Request Body

Array of experiment definitions.

Request Example json
[
  { "type": "cpu-stress", "enabled": true },
  { "type": "latency-injection", "enabled": true }
] 
POST /chaos/results/upload

Upload historical chaos experiment results. These are used to train the selection engine and detect entanglement patterns.

More data = better probabilistic modeling and adaptive selection.

Request Body

  • project_id string, required
  • results array, required

    Historical experiment executions

Request Example json
{
  "project_id": "<YOUR_PROJECT_ID>",
  "results": [
    {
      "service": "payment-service",
      "experiment_type": "cpu-stress",
      "passed": false,
      "timestamp": "2026-02-01T10:00:00Z",
      "duration_ms": 1200,
      "error": "timeout"
    }
  ]
} 
GET /functional/select

Intelligent functional test selection with commit-aware boosting. Analyzes code changes, test history, and runtime context to select the minimal set of tests needed to validate changes with confidence.

Tests affected by recent commits can receive a boost. The engine learns over time from results you upload, improving selection quality.

Query Parameters

  • project_id string, required

    Project identifier

  • lookback_commits_hours integer, optional

    Hours to analyze commits (0=disabled). Default: 24

Commit-Aware Boosting

Tests affected by recent commits receive automatic priority:

  • Base boost: 1.5x for affected tests
  • +0.2x per commit (max +0.5x)
  • +0.3x for fix commits
  • +0.1x for feature commits
Request Example curl
curl "https://api.quantikmind.com/api/v1/functional/select?project_id=ecommerce&lookback_commits_hours=48" \
  -H "X-API-Key: qm_sk_live_..." 
Response Example json
{
  "run_id": "<RUN_ID>",
  "project_id": "<YOUR_PROJECT_ID>",
  "tau": 0.65,
  "counts": {
    "total": 2847,
    "selected": 412
  },
  "reduction_percentage": 85.5,
  "selected": [
    {
      "test_id": "test_checkout_flow",
      "test_name": "E2E Checkout with Payment",
      "service": "checkout-service",
      "service_instance": "checkout-service-001",
      "origin": "superposition",
      "execution_value": 89.2,
      "p_initial": 91.3,
      "selected": true,
      "commit_affected": true,
      "reason": "High risk + recent commits to checkout.ts"
    },
    {
      "test_id": "test_payment_gateway",
      "test_name": "Payment Gateway Integration",
      "service": "payment-service",
      "service_instance": "payment-service-002",
      "origin": "entanglement",
      "execution_value": 87.5,
      "p_initial": 88.1,
      "selected": true,
      "commit_affected": false,
      "reason": "Entangled with checkout-service"
    }
  ],
  "impact_snapshot": {
    "high_risk_tests": 89,
    "medium_risk_tests": 201,
    "low_risk_tests": 122
  },
  "commit_consideration": {
    "enabled": true,
    "lookback_hours": 48,
    "affected_tests": 127,
    "tests_with_boost": 89
  }
}
GET /functional/runs/{run_id}/decision-insight

Returns a detailed explanation of why each test was selected or skipped in a functional selection run. Use it to audit decisions and build trust in automation.

The response highlights signals used by the engine (history, commits, runtime anomalies), and how they contributed to the final decision.

Path Parameters

  • run_id string, required

    Run identifier returned by /functional/select

Response Fields (Typical)

  • final_score - Final ranking score
  • confidence - Decision confidence (0–1)
  • signals - Breakdown of contributing signals
  • selection_reason - Human-readable explanation
Request Example curl
curl "https://api.quantikmind.com/api/v1/functional/runs/<RUN_ID>/decision-insight" \
  -H "X-API-Key: qm_sk_live_..." 
Response Example json
{
  "test_id": "test_checkout_flow",
  "final_score": 0.89,
  "confidence": 0.91,
  "selected": true,
  "selection_reason": [
    "Recent commits affected checkout.ts",
    "High historical failure rate",
    "Runtime latency anomaly detected"
  ],
  "signals": {
    "historical_risk": 0.72,
    "commit_impact": 0.81,
    "runtime_anomaly": 0.64
  },
  "quantum_origin": "superposition"
} 
GET functional/library

Returns the full functional test library for a given project. Use this endpoint to inspect, audit, or debug the test space used by the selection engine.

Results are always fresh and not cached to ensure consistency with the latest uploaded data.

Query Parameters

  • project_id string (UUID), required

    Project identifier (UUID returned at project creation)

Behavior

  • Returns all tests ordered by service, suite, and name
  • Includes full metadata stored in the library
  • No caching (real-time consistency guaranteed)
Request Example curl
curl "https://api.quantikmind.com/api/v1/functional/library?project_id=<RUN_ID>" \
  -H "Authorization: Bearer qm_sk_live_..." 
Response Example json
{
  "data": [
    {
      "test_id": "auth-login-001",
      "name": "Login Test",
      "service": "auth-service",
      "suite": "authentication",
      "business_criticality": "high"
    },
    {
      "test_id": "checkout-002",
      "name": "Checkout Flow",
      "service": "payment-service",
      "suite": "checkout",
      "business_criticality": "critical"
    }
  ],
  "total": 2175
} 
POST /functional/library/import

Imports your functional test library into Quantik Mind. Include metadata like file paths, expected durations, and code mappings to improve selection accuracy.

Typically a one-time setup. Re-import anytime your suite changes.

Request Body

  • project_id string, required

    Project identifier

  • tests array, required

    Array of test definitions with metadata

Test Object Schema

  • test_id - Unique identifier (required)
  • name - Human-readable test name (required)
  • service - Associated service (required)
  • suite - Test suite name (default: "default")
  • business_criticality - Values: low, medium, high, critical (default: medium)
  • tags - Array of tags: ["smoke", "e2e"]
  • avg_duration_ms - Average execution time in milliseconds
  • framework - Test framework: pytest, selenium, junit, etc.
  • test_level - Level: unit, integration, e2e
  • code_mapping.file_globs - File patterns: ["src/auth/**/*.py"]
Request Example curl
curl -X POST https://api.quantikmind.com/api/v1/functional/library/import \
  -H "Authorization: Bearer qm_sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "project_id": "<YOUR_PROJECT_ID>",
    "tests": [
      {
        "test_id": "test_checkout_001",
        "name": "Complete Checkout Flow",
        "service": "checkout-service",
        "suite": "checkout",
        "business_criticality": "high",
        "tags": ["e2e", "critical"],
        "avg_duration_ms": 2500,
        "code_mapping": {
          "file_globs": ["src/checkout/**/*.ts", "src/payment/*.ts"]
        }
      }
    ]
  }'
POST /functional/results/upload

Upload test execution results to improve selection accuracy over time. The model learns from outcomes, durations, and failures to make better predictions.

Call this after executing selected tests in CI/CD.

Request Body

  • run_id string, required

    Run ID from selection response

  • results array, required

    Results (test_id, passed, duration_ms, error)

  • total_coverage float, optional

    Actual code coverage (0–1)

Request Example curl
curl -X POST https://api.quantikmind.com/api/v1/functional/results/upload \
  -H "Authorization: Bearer qm_sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "run_id": "<RUN_ID>",
    "results": [
      { "test_id": "test_checkout_001", "passed": true, "duration_ms": 238 },
      { "test_id": "test_payment_002", "passed": false, "duration_ms": 1920, "error": "Connection timeout" }
    ],
    "total_coverage": 0.91
  }' 
GET /runs/

Retrieves all selection runs (chaos and functional) with pagination. Useful for dashboards, governance, and monitoring selection effectiveness over time.

Query Parameters

  • project_id string, required

    Project identifier

  • run_type string, optional

    "chaos", "functional", or "all". Default: all

  • limit integer, optional

    Results per page (1–100). Default: 50

  • offset integer, optional

    Pagination offset. Default: 0

Request Example curl
curl "https://api.quantikmind.com/api/v1/runs/?project_id=<YOUR_PROJECT_ID>&run_type=chaos&limit=10" \
  -H "X-API-Key: qm_sk_live_..." 
GET /runs/{run_id}

Fetches details for a specific run, including selected tests, KPIs, distributions, and metadata.

Path Parameters

  • run_id string, required

    Run identifier from selection response

Request Example curl
curl "https://api.quantikmind.com/api/v1/runs/<RUN_ID>" \
  -H "X-API-Key: qm_sk_live_..." 
GET /functional/runs/{run_id}/decision-insight

Returns consolidated decision metrics for a completed functional selection run. This endpoint provides a read-only overview of selection performance, quantum distribution, and risk coverage.

The response aggregates post-run statistics and does not depend on runtime selection state.

Path Parameters

  • run_id string, required

    Unique identifier of a completed selection run

Response Fields

  • tests.total – Total tests in library
  • tests.selected – Number of selected tests
  • tests.reduction_percentage – Test reduction achieved
  • quantum.distribution – Superposition / Entanglement / Uncertainty breakdown
  • risk.coverage_percentage – Risk coverage achieved
  • always_green.avoided – Tests avoided due to always-green filtering
Request Example curl
curl "https://api.quantikmind.com/api/v1/functional/runs/<RUN_ID>/decision-insight" \
  -H "Authorization: Bearer qm_sk_live_..." 
Response Example json
{
  "run_id": "<RUN_ID>",
  "project_id": "<YOUR_PROJECT_ID>",
  "run_type": "functional",
  "created_at": "2026-02-12T08:32:10Z",

  "tests": {
    "total": 2175,
    "selected": 184,
    "reduction_percentage": 91.5
  },

  "quantum": {
    "distribution": {
      "superposition": 120,
      "entanglement": 42,
      "uncertainty": 22
    }
  },

  "risk": {
    "coverage_percentage": 94.2,
    "efficiency": 0.87,
    "top25_share": 0.63
  },

  "always_green": {
    "avoided": 318,
    "avoided_percentage": 14.6
  }
} 
POST /projects/

Create a new project and configure its runtime observability settings. This is the first step when onboarding a system into Quantik Mind.

Request Body

  • name string, required

    Project name (human-readable)

  • project_id string, required

    Unique project identifier (slug)

  • observability_url string, optional

    Base endpoint for runtime observability signals (e.g., Prometheus, OpenTelemetry, or compatible systems).

Request Example curl
curl -X POST https://api.quantikmind.com/api/v1/projects/ \
  -H "Authorization: Bearer qm_sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Banking Platform",
    "project_id": "<YOUR_PROJECT_ID>",
    "observability_url": "http://prometheus.internal:9090"
  }' 

Error Codes

Quantik Mind uses standard HTTP status codes. All error responses include a JSON body with error and message fields.

400

Bad Request

Invalid parameters or malformed JSON

401

Unauthorized

Missing or invalid API token

403

Forbidden

Insufficient permissions

404

Not Found

Resource does not exist

429

Too Many Requests

Rate limit exceeded

500

Internal Server Error

Contact support if persists

Error Response Formatjson
{
  "error": "invalid_request",
  "message": "Missing required parameter: project_id",
  "details": { "field": "project_id", "type": "required" }
} 

Rate Limits

API rate limits are enforced per API key to ensure fair usage and system stability. Rate limit headers are included in every response.

Starter Tier

100

requests per hour

Professional Tier

1,000

requests per hour

Platinum Tier

Custom

tailored to your needs

Rate Limit Headers

Every API response includes rate limit information:

Response Headers
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 847
X-RateLimit-Reset: 1706025600 

💡 Tip: If you're consistently hitting rate limits, consider upgrading to a higher tier or contact us for custom limits.

Webhooks

Enable event-driven test selection by connecting your repository via webhooks. On every push event, Quantik Mind analyzes commit metadata and code changes to dynamically select the most relevant functional tests.

GitHub Webhook (Recommended)

Repository → Settings → Webhooks → Add webhook

https://api.quantikmind.com/api/v1/functional/commits/webhook
application/json

Get your webhook secret from Quantik Mind dashboard → Settings → Webhooks

Select "Just the push event"

Also compatible with GitLab, Azure DevOps, Jenkins, and custom pipelines via API.

🔒 Security: Webhook payloads are verified using HMAC SHA-256 signatures

Quantik Mind validates the X-Hub-Signature-256 header against your organization-specific webhook secret to ensure authenticity and integrity.

Example Webhook Payloadjson
{
  "ref": "refs/heads/main",
  "repository": {
    "full_name": "org/repo"
  "commits": [
    {
      "id": "a7f3d9e2...",
      "message": "Fix payment gateway timeout",
      "added": ["src/payment/timeout.ts"],
      "modified": ["src/payment/gateway.ts"],
      "removed": []
    }
  ]
}