Stop recording

View as Markdown
**Rate limit: Per command** · **Burst:** 20 · **Refill:** 20 req/s Stop the [Recording](/api/recording) identified by `recording_uuid`. The `202 Accepted` response confirms that the command was admitted. It does not confirm that the recording has stopped or that the final audio is available. **Later lifecycle outcomes:** - `recording.ended` is emitted immediately after the recording file is closed. It carries `recording_uuid`, the signed public `media_url`, the `operation_uuid` of the originating recording-create request, and `duration`. - A `media_url` request started at that boundary may briefly remain on the growing-recording path while finalization completes. - A `recording.failed` event is not always final. If a later stop command is accepted, the same recording also emits `recording.ended`. The signed `media_url` carried by `recording.ended` expires 24 hours after that event is emitted by default. After internal finalization it supports HTTP Range requests. See [Recording lifecycle events](/api/recording#lifecycle-events) for complete payload schemas and examples.

Authentication

AuthorizationBearer
Application auth. Send `Authorization: Bearer <app_uuid>:<api_key>` using any active key in the app's collection. See [Authentication](https://voice-platform.docs.buildwithfern.com/api/authentication) for details.

Path parameters

uuidstringRequired

Session identifier.

recording_uuidstringRequiredformat: "^rec_[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"

Headers

Idempotency-KeystringOptionalformat: "^[a-zA-Z0-9._-]+$"<=128 characters
Optional key for safely retrying mutating requests. See [Idempotency](https://voice-platform.docs.buildwithfern.com/idempotency) for details.
Operation-IdstringOptionalformat: "uuid"

optional client-supplied lowercase RFC-4122 v4 UUID returned as operation_uuid; platform generates one when omitted; correlation metadata distinct from Idempotency-Key.

Request

This endpoint expects an object.

Response

Command accepted for async execution
operation_uuidstringformat: "uuid"
statusenum
already_endedtrueOptional

Optional. Set to true on idempotent terminal commands when the session was already in a terminal state at the time the request was received. Absent otherwise.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error