---
title: "Start a screen recording. Only one recording per ID can be registered at a time."
method: POST
path: "/recording/start"
---

# Start a screen recording. Only one recording per ID can be registered at a time.

`POST /recording/start`

## Request body

- StartRecordingRequest
  - `maxFileSizeInMB` integer — Maximum file size in MB (overrides server default)
  - `framerate` integer — Recording framerate in fps (overrides server default)
  - `maxDurationInSeconds` integer — Maximum recording duration in seconds (overrides server default)
  - `recordAudio` boolean — Capture audio alongside video. Requires the server to have an audio source and PulseAudio socket configured (the image sets both by default). When false the recording is video-only.
  - `id` string — Optional identifier for this recording session, used to target it from the other /recording endpoints (stop, mark, download, delete) and allowing multiple concurrent recordings. Alphanumeric or hyphen. When omitted, the default recording session is started.

## Response `201`

Recording started

## Other responses

- `400` — Bad Request
- `409` — Conflict
- `500` — Internal Server Error

## Changes

- **2026-06-01** `4626aaaac8ed` — 1 info
  - added the new optional request property `recordAudio`
- **2025-07-28** `bf31c0efd637` — 1 breaking
  - the `framerate` request property's max was decreased to `20.00`
- **2025-07-15** `34fa756d4915` — 3 info
  - added the new optional request property `id`
  - added the new optional request property `maxDurationInSeconds`
  - added the non-success response with the status `400`
- **2025-06-27** `f980a92ab23f` — 3 warning, 2 info
  - removed the request property `id`
  - removed the request property `maxDurationInSeconds`
  - removed the request property `recordAudio`
  - the `framerate` request property's max was increased from `20.00` to `60.00`
  - …1 more

[Change history](https://skmtc.dev/kernel/apis/kernel-images-api/changes/recording/start/post.md)

---

[API](https://skmtc.dev/kernel/apis/kernel-images-api.md) · [All operations](https://skmtc.dev/kernel/apis/kernel-images-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kernel/kernel-images-api/revisions/7a641fa15a85/schema)