---
title: "Stop Recording Episode"
method: POST
path: "/recording/stop"
tags: ["recording"]
---

# Stop Recording Episode

`POST /recording/stop`

## Request

- The document declares no server URL.
- Auth: none required

Stop the recording of the episode. The data is saved to disk to the user home directory, in the `phosphobot` folder.

## Request body

- RecordingStopRequest: Request to stop the recording of the episode.
  - `save` boolean: Whether to save the episode to disk. Defaults to True.

## Response `200`

Successful Response

- RecordingStopResponse: Response when the recording is stopped. The episode is saved in the given path.
  - `episode_folder_path` string, nullable, required: Path to the folder where the episode is saved.
  - `episode_index` integer, nullable, required: Index of the recorded episode in the dataset.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/phospho/apis/phospho-api.md) - [All operations](https://skmtc.dev/phospho/apis/phospho-api/llms.txt) - [OpenAPI document](https://skmtc.dev/phospho/apis/phospho-api/revisions/93e83588fc02?raw)