Automatic recording | Doc Detective

The video autoRecord made of this context. Absent when no automatic recording was attempted, including when autoRecord is unset and the run’s recording check failed. Present only in test results. System-populated.

Referenced In

Resolved context

Fields

Field	Type	Description	Default
result	string	Required. Outcome of the automatic recording, from starting it through saving it. A `FAIL` or `WARNING` also sets the context’s `result`. A `PASS` or `SKIPPED` doesn’t. Accepted values: `PASS`, `FAIL`, `WARNING`, `SKIPPED`	—
resultDescription	string	Optional. Why the automatic recording had its outcome. Absent on a `PASS`.	—
resultCode	string	Optional. What kind of failure this was, present only when `result` is `FAIL`. The same field and values as a step’s `resultCode`. `environment` means the network, the browser session, or the page load failed. `assertion` means anything else. Accepted values: `environment`, `drift`, `assertion`	—
resultHint	string	Optional. A suggested fix for a failed recording. The same field as a step’s `resultHint`. Present only when Doc Detective has a suggestion.	—
recordingPath	string	Optional. Path of the saved video, relative to the run’s artifact directory (the report’s `runDir`), with forward slashes. Absent when no file was written.	—
startedAt	string	Optional. When the recording started, as an ISO 8601 UTC timestamp with milliseconds. Absent when it didn’t start.	—
format	string	Optional. File format of the saved video, for example `mp4`. Absent when no file was written.	—
duration	number	Optional. Length of the saved video in seconds. Absent when it couldn’t be read from the file. Minimum: 0	—
width	integer	Optional. Width of the saved video in pixels. Absent when it couldn’t be read from the file. Minimum: 0	—
height	integer	Optional. Height of the saved video in pixels. Absent when it couldn’t be read from the file. Minimum: 0	—
fps	number	Optional. Frame rate of the saved video. Absent when it couldn’t be read from the file. Minimum: 0	—

Examples

{
  "result": "PASS",
  "recordingPath": "specs/install-guide/tests/install/contexts/linux-chrome/recordings/linux-chrome.mp4",
  "startedAt": "2026-11-06T02:33:29.010Z",
  "format": "mp4",
  "duration": 8.1,
  "width": 1280,
  "height": 720,
  "fps": 30
}

{
  "result": "SKIPPED",
  "resultDescription": "Skipped: couldn't start the automatic recording: the host has no display. Set `autoRecord: false` to turn it off."
}