Sentinel Client

Official Sentinel helper that lets you call the hosted API with one API key and zero YAML wiring.

Features

• Creates runs (POST /api/v1/runs) and hosted jobs.
• Uploads Playwright (or any) JSON results (/runs/:id/tests) and marks runs as completed (/runs/:id/complete).
• Requests signed artifact upload URLs (/artifacts/upload-urls) and reports guardrail violations.
• Triggers AI code review jobs, self-heal actions, and visual diffs.
• Exposes a single SentinelClient and typed payload helpers.

Quick start

import { SentinelClient } from '@sentinelqa/client'

const client = new SentinelClient({
  apiKey: process.env.SENTINEL_API_KEY,
  apiBaseUrl: 'https://app.sentinelqa.io'
})

const { runId } = await client.createRun({
  projectId: '...',
  environmentKey: 'prod',
  triggerSource: 'github',
  commitSha: '...',
  branch: 'main'
})

await client.uploadTestResults(runId, {
  tests: [{ name: 'Home page test', status: 'passed' }]
})

await client.completeRun(runId, { status: 'passed' })

Documentation

Visit the Sentinel dashboard to create an API key, then wire SENTINEL_API_KEY, SENTINEL_PROJECT_ID, and SENTINEL_ENVIRONMENT_KEY into your CI job. The client takes care of headers, signatures, error formatting, and scope awareness.

Note: Visual diff uploads rely on FormData/Blob (Node 18+ or browser). Provide polyfills or pass a compatible fetch/FormData implementation if your runtime is older.