Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/davidG97/qa-flow/llms.txt

Use this file to discover all available pages before exploring further.

The Test Runs API provides persistent, queryable access to every execution that QA Flow has performed. Each test run is stored as a TestRun record in the database, with a nested array of TestResult objects — one for every node that was executed. You can list recent runs globally, fetch all runs for a specific project, drill into a single run’s full results, or retrieve the generated HTML report for any completed run.

TestRun Object

id
string
UUID of the test run.
projectId
string
UUID of the project this run belongs to.
status
string
Lifecycle status of the run. One of: pending, running, completed, failed.
startedAt
string | null
ISO 8601 timestamp when execution began, or null if still pending.
completedAt
string | null
ISO 8601 timestamp when execution finished, or null if still running.
error
string | null
Top-level error message if the entire run failed; null otherwise.
totalTests
number
Total number of nodes executed in the run.
passedTests
number
Number of nodes that passed.
failedTests
number
Number of nodes that failed.
duration
number | null
Total execution time in milliseconds, or null if not yet complete.
createdAt
string
ISO 8601 timestamp when the TestRun record was created in the database.
results
TestResult[]
Array of per-node result records. Populated when fetching an individual run via GET /api/test-runs/:id.

GET /api/test-runs

List the most recent test runs across all projects. Results are ordered by creation date descending. Use the limit query parameter to control the number of records returned. Authentication required: No

Query Parameters

limit
number
Maximum number of test runs to return. Defaults to 20.

Response

An array of TestRun objects (without the nested results array for performance — use GET /api/test-runs/:id to fetch results).
curl 'http://localhost:3001/api/test-runs?limit=5'

GET /api/test-runs/:id

Retrieve a single test run with its complete array of TestResult records. Use this endpoint to display a full execution report with per-node pass/fail details. Authentication required: No

Path Parameters

id
string
required
The UUID of the test run to retrieve.

Response

A TestRun object with a populated results array. Returns 404 Not Found if the run does not exist.
curl http://localhost:3001/api/test-runs/run-aaa-111

GET /api/test-runs/project/:projectId

Retrieve the most recent test runs for a specific project, ordered by creation date descending. Useful for displaying a project’s run history in the UI. Authentication required: No

Path Parameters

projectId
string
required
The UUID of the project whose run history to retrieve.

Query Parameters

limit
number
Maximum number of test runs to return. Defaults to 10.

Response

An array of TestRun objects (without nested results).
curl 'http://localhost:3001/api/test-runs/project/proj-abc-123?limit=3'

GET /api/test-runs/:id/report

Retrieve the HTML report generated for a completed test run. The response format is determined by content negotiation using the Accept header. Authentication required: No

Path Parameters

id
string
required
The UUID of the test run whose report to retrieve.

Content Negotiation

When the request includes Accept: text/html, the server responds with the raw HTML report suitable for rendering directly in a browser iframe or a new tab.
curl http://localhost:3001/api/test-runs/run-aaa-111/report \
  -H 'Accept: text/html'
Response: Content-Type: text/html — full rendered HTML report.
Returns 404 Not Found with { "error": "Reporte no encontrado" } if no report has been generated for the specified test run yet. Reports are created automatically when a run completes.

Build docs developers (and LLMs) love