---
title: "Start recording a sign-in"
method: POST
path: "/v1/web-recorder/start"
tags: ["web-recorder"]
---

# Start recording a sign-in

`POST /v1/web-recorder/start`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/web-recorder/start`
- Auth: HTTP bearer

Begin a sign-in recording session for a web asset, given a url. Returns a session id, the url, and the steps recorded so far, which starts empty. Steps are then submitted using the Brix Recorder browser extension.

**Notes.**
- The recorder browser extension then sends each step with `action`. Invalid input answers 400, not 422.

## Request body

- object
  - `url` string, required: The sign-in page (http or https, a public host).

## Response `200`

Success.

- object
  - `data` object, required
    - `url` string, required: The page the recording is on now.
    - `steps` RecordedStep[], required
      - `kind` string, required: `navigate`, `click`, `enter-text`, `scroll`, `accept-cookies`, `wait`, or a picker step.
      - `url` string
      - `selector` string
      - `label` string
      - `value` string: Typed text that is not secret.
      - `valueRef` string: For secret text: a reference; the value is never recorded. Send it in `finalize`'s `secrets`.
      - `pixels` number
      - `ms` number
    - `startedAt` integer, required: Milliseconds since the Unix epoch (not an ISO timestamp).
    - `spaceId` string, required
    - `sid` string, required
    - `ok` true, required

## Other responses

- `400`: `url` is not http(s), or not a public address.
- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `503`: Recording is not available in this environment.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)