Skip to main content
POST
/
recording
/
stop
Stop Recording Episode
curl --request POST \
  --url https://api.example.com/recording/stop \
  --header 'Content-Type: application/json' \
  --data '{
  "save": true
}'
{
  "episode_folder_path": "<string>",
  "episode_index": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.phospho.ai/llms.txt

Use this file to discover all available pages before exploring further.

Body

application/json

Request to stop the recording of the episode.

​
save
boolean
default:true

Whether to save the episode to disk. Defaults to True.

Response

Successful Response

Response when the recording is stopped. The episode is saved in the given path.

​
episode_folder_path
string | null
required

Path to the folder where the episode is saved.

​
episode_index
integer | null
required

Index of the recorded episode in the dataset.