Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.

Skip to main content

Support
Book a demo
Book a demo

Book a demo

Overview

API reference
Authentication
Availability notes

Twins

GET List available twins
POST Provision twins
GET Get twin provision status
POST Extend twin provision TTL
POST Tear down twin provision
POST Lock twin provision public access

Scenarios

GET List preset scenarios
POST Create a scenario
GET List scenarios
GET List scenario long runs
GET Get a scenario
PUT Update a scenario
DELETE Delete a scenario

Runner

POST Create a runner run
POST Rerun a runner run
GET List runner runs
GET Get a runner run
PATCH Update runner config
POST Send runner message
GET Get runner artifact
WEBSOCKET Stream runner events

Tests

GET List tests
POST Save a test
GET Get a test
POST Run a test
PATCH Update a test
DELETE Delete a test

PR test runs

POST Install PR Test Runs
GET Get PR Test Run config
POST Save PR Test Run config
PATCH Toggle GitHub CI config
GET List enabled GitHub CI repos
POST Start a PR Test Run
GET List CI validation runs

Logs and artifacts

GET Get validation run details
GET Get validation run logs
GET Stream validation results
POST Cancel a validation run
GET Get validation run artifact

Runner

WEBSOCKET Stream runner events

Subscribe to run progress events

WEBSOCKET /runner/runs/{run_id}/stream

Streams run events for the authenticated user. The server sends JSON event payloads as the runner run progresses.

GET Get runner artifact

github x linkedin website

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform

Assistant

Responses are generated using AI and may contain mistakes.