opntasks
API Reference

Run Sessions

Run session management endpoints.

Run Sessions

A run session represents a single execution of an agent. Tasks are always submitted within the context of a run.

Start a run

POST /api/v1/runs
{
  "projectType": "accessibility-audit",
  "targetUrl": "https://example.com",
  "metadata": {
    "branch": "main",
    "commit": "abc123"
  }
}

Response

{
  "id": "run_xyz789",
  "projectType": "accessibility-audit",
  "status": "running",
  "createdAt": "2026-03-31T10:00:00Z"
}

List runs

GET /api/v1/runs

Query parameters

ParameterTypeDescription
projectTypestringFilter by project type
statusstringrunning, completed, failed
pagenumberPage number
limitnumberItems per page

Get run details

GET /api/v1/runs/:id

Returns run metadata plus a summary of task counts by severity and status.

On this page