Ingest API v2 reference

GET /healthz

Liveness probe - Health check served directly by the ingest service: self-hosted deployments, local development, direct ingest URLs, and the conformance mock. The official Playwright JS reporter currently probes this path before streaming, with a 2 second timeout, and disables itself for the run if it is unreachable. NOTE: on the m00nreport.com cloud apex this path is currently handled by the frontend edge - only specific path prefixes (such as /api/*) reach the backend there, and /healthz is not among them - use /api/ingest/health when probing through that edge instead. No authentication. Any server implementing this contract should serve BOTH health paths.

{
  "ok": true,
  "service": "ingest"
}

Responses: 200 (Service is alive)

GET /api/ingest/health

Liveness probe (cloud-routable) - Same liveness semantics as /healthz, but routable through edges/proxies where only specific path prefixes (such as /api/*) reach the backend - including the m00nreport.com cloud, where /healthz is not among the reachable prefixes. Prefer this path when probing through such an edge. No authentication.

{
  "ok": true,
  "service": "ingest"
}

Responses: 200 (Service is alive)

POST /api/ingest/v2/run/start

Start a run - Creates a run. The project is derived from the API key. Returns the server-generated runId used by all subsequent calls.

{
  "launch": "Nightly regression",
  "tags": [
    "smoke"
  ],
  "total": 42,
  "startedAt": "2026-07-17T21:00:00.000Z"
}

Responses: 200 (Success), 401 (Missing or invalid API key), 403 (Run belongs to another organization, or writes are blocked by subscription status), 500 (Unexpected server error)

POST /api/ingest/v2/test/start

Register a test attempt (fire-and-forget) - Registers a client-generated testId so steps can stream before the test finishes. Safe to send without awaiting the response.

{
  "runId": "3f0f1e6a-7b1c-4b6e-9a52-1c2d3e4f5a6b",
  "testId": "9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d",
  "titlePath": [
    "auth.spec.ts",
    "Login",
    "valid credentials"
  ],
  "filePath": "tests/auth.spec.ts",
  "retry": 0,
  "startedAt": "2026-07-17T21:00:01.000Z"
}

Responses: 200 (Success), 401 (Missing or invalid API key), 403 (Run belongs to another organization, or writes are blocked by subscription status), 409 (Run is no longer active (stopped or interrupted)), 500 (Unexpected server error)

POST /api/ingest/v2/test/complete

Complete a test attempt

{
  "runId": "3f0f1e6a-7b1c-4b6e-9a52-1c2d3e4f5a6b",
  "testId": "9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d",
  "titlePath": [
    "auth.spec.ts",
    "Login",
    "valid credentials"
  ],
  "status": "passed",
  "retry": 0,
  "duration": 4210,
  "startedAt": "2026-07-17T21:00:01.000Z",
  "endedAt": "2026-07-17T21:00:05.210Z",
  "steps": [],
  "attachments": []
}

Responses: 200 (Success), 401 (Missing or invalid API key), 403 (Run belongs to another organization, or writes are blocked by subscription status), 409 (Run is no longer active (stopped or interrupted)), 500 (Unexpected server error)

POST /api/ingest/v2/steps/stream

Stream live step events (batched) - Batch of step events, possibly spanning multiple tests and runs. Every unique runId in the batch is ownership-checked.

{
  "items": [
    {
      "runId": "3f0f1e6a-7b1c-4b6e-9a52-1c2d3e4f5a6b",
      "testId": "9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d",
      "title": "page.click(#login)",
      "action": "end",
      "status": "passed",
      "duration": 120,
      "nestingLevel": 0,
      "stepIndex": 3
    }
  ]
}

Responses: 200 (Success), 401 (Missing or invalid API key), 403 (Run belongs to another organization, or writes are blocked by subscription status), 409 (Run is no longer active (stopped or interrupted)), 500 (Unexpected server error)

POST /api/ingest/v2/run/end

End a run

{
  "runId": "3f0f1e6a-7b1c-4b6e-9a52-1c2d3e4f5a6b",
  "status": "finished",
  "endedAt": "2026-07-17T21:05:00.000Z"
}

Responses: 200 (Success), 401 (Missing or invalid API key), 403 (Run belongs to another organization, or writes are blocked by subscription status), 500 (Unexpected server error)

POST /api/ingest/v2/attachment/upload

Upload attachments (buffered multipart) - For small files. Multipart form with runId, testId fields and up to 10 file parts.

Responses: 200 (Success), 400 (runId and testId are required, or no files provided), 401 (Missing or invalid API key), 403 (Run belongs to another organization, or writes are blocked by subscription status), 409 (Run is no longer active (stopped or interrupted)), 413 (Per-run attachment byte quota exceeded), 500 (Unexpected server error)

POST /api/ingest/v2/attachment/stream

Upload large attachments (streaming multipart) - For large files (videos, traces). Streams to storage without buffering. Send runId and testId fields BEFORE file parts.

Responses: 200 (Success), 400 (runId and testId are required, or no files uploaded), 401 (Missing or invalid API key), 403 (Run belongs to another organization, or writes are blocked by subscription status), 409 (Run is no longer active (stopped or interrupted)), 413 (Per-run attachment byte quota exceeded), 500 (Unexpected server error)

POST /api/ingest/v2/attachment/presign

Get a presigned direct-upload URL (or check capability) - With {"check": true}: returns whether direct upload is supported. Otherwise returns a presigned PUT URL valid for 10 minutes; upload the file there, then call attachment/confirm.

{
  "runId": "3f0f1e6a-7b1c-4b6e-9a52-1c2d3e4f5a6b",
  "testId": "9a1b2c3d-4e5f-4a6b-8c7d-0e1f2a3b4c5d",
  "filename": "trace.zip",
  "contentType": "application/zip",
  "size": 1048576
}

Responses: 200 (Success), 400 (Missing required fields: runId, testId, filename, contentType), 401 (Missing or invalid API key), 403 (Run belongs to another organization, or writes are blocked by subscription status), 409 (Run is no longer active (stopped or interrupted)), 413 (Per-run attachment byte quota exceeded), 500 (Unexpected server error)

POST /api/ingest/v2/attachment/confirm

Confirm a direct upload - Records the attachment after a successful presigned PUT. Quota was already reserved at presign time.

{
  "success": true,
  "attachmentId": "7c8d9e0f-1a2b-4c3d-8e5f-6a7b8c9d0e1f",
  "objectName": "autotests-attachments/7c8d9e0f-1a2b-4c3d-8e5f-6a7b8c9d0e1f"
}

Responses: 200 (Success), 400 (Missing required fields: runId, testId, attachmentId, filename), 401 (Missing or invalid API key), 403 (Run belongs to another organization, or writes are blocked by subscription status), 409 (Run is no longer active (stopped or interrupted)), 500 (Unexpected server error)

ErrorEnvelope

RunQuota

Per-run attachment byte quota, by pricing tier.

AttachmentResult

One stored attachment, as returned by attachment/upload and attachment/stream.

StepItem

One step event. Items without runId, testId and title are silently skipped by the server.

EmbeddedStep

One step embedded in test/complete's steps array (distinct from steps/stream's StepItem: no runId/testId per item, since the parent call already carries both for the whole array). No field is required - the server accepts partial items and falls back to array position for ordering when index/stepIndex is omitted.

EmbeddedAttachment

One inline base64-encoded attachment embedded in test/complete's attachments array (distinct from AttachmentResult, the shape the upload endpoints return). Only sent when the reporter uses binaryAttachments:false; with the default binaryAttachments:true, files are uploaded separately via attachment/upload or attachment/stream and this array is empty. Items without data or name are silently skipped by the server.