OpenQAOpenQA
API Reference

Data API

API endpoints for retrieving test data, sessions, bugs, and agent information.

GET/api/status

Get the current agent status

Response
{
  "status": "running",
  "pid": 12345,
  "uptime": 3600,
  "currentSession": "session_abc123",
  "testsGenerated": 47,
  "bugsFound": 3,
  "lastActivity": "2024-01-15T10:30:00Z"
}
GET/api/tests

Get all generated tests

Response
[
  {
    "id": "test_001",
    "name": "test_checkout_flow.spec.ts",
    "type": "e2e",
    "status": "passed",
    "duration": 2300,
    "createdAt": "2024-01-15T10:30:00Z",
    "lastRun": "2024-01-15T11:00:00Z"
  },
  {
    "id": "test_002",
    "name": "test_login_security.spec.ts",
    "type": "security",
    "status": "failed",
    "duration": 1500,
    "createdAt": "2024-01-15T10:35:00Z",
    "lastRun": "2024-01-15T11:00:00Z"
  }
]
GET/api/tests/:id

Get a specific test by ID

Response
{
  "id": "test_001",
  "name": "test_checkout_flow.spec.ts",
  "type": "e2e",
  "status": "passed",
  "code": "import { test, expect } from '@playwright/test';...",
  "runs": [
    {
      "runId": "run_001",
      "status": "passed",
      "duration": 2300,
      "timestamp": "2024-01-15T11:00:00Z"
    }
  ]
}
GET/api/sessions

Get all test sessions

Response
[
  {
    "id": "session_abc123",
    "status": "completed",
    "testsRun": 15,
    "testsPassed": 13,
    "testsFailed": 2,
    "bugsFound": 1,
    "startedAt": "2024-01-15T10:00:00Z",
    "completedAt": "2024-01-15T10:30:00Z"
  }
]
GET/api/bugs

Get all discovered bugs

Response
[
  {
    "id": "bug_001",
    "title": "XSS vulnerability in search input",
    "severity": "high",
    "testId": "test_002",
    "description": "The search input does not sanitize user input...",
    "screenshot": "/screenshots/bug_001.png",
    "githubIssue": "https://github.com/org/repo/issues/123",
    "createdAt": "2024-01-15T10:35:00Z"
  }
]
GET/api/dynamic-agents

Get all created dynamic agents

Response
[
  {
    "id": "agent_001",
    "name": "Checkout Flow Tester",
    "purpose": "Test checkout flow with various payment methods",
    "testsGenerated": 5,
    "bugsFound": 2,
    "status": "active",
    "createdAt": "2024-01-15T10:00:00Z"
  }
]
GET/api/kanban/tickets

Get all Kanban board tickets

Response
[
  {
    "id": "ticket_001",
    "title": "Fix XSS in search",
    "description": "The search input needs sanitization",
    "status": "todo",
    "priority": "high",
    "bugId": "bug_001",
    "createdAt": "2024-01-15T10:35:00Z"
  }
]
PATCH/api/kanban/tickets/:id

Update a Kanban ticket status

Request Body
{
  "status": "in_progress"
}
Response
{
  "id": "ticket_001",
  "status": "in_progress",
  "updatedAt": "2024-01-15T11:00:00Z"
}

Ticket Statuses

StatusDescription
backlogFuture test ideas
todoBugs to fix
in_progressBeing worked on
doneResolved