Skip to main content
PUT
Update Transcription

Overview

Replaces the transcription stored for a specific appointment, looked up by appointment_id. The supplied array fully replaces the existing transcription, the appointment status is set to processing, and its error reason is cleared.
This endpoint finds the transcription by appointment ID and replaces its content. The appointment status is set to processing and its error reason is cleared.

Authentication

string
required
Bearer JWT token. The calling user is derived from the token.

Path Parameters

string
required
The appointment ObjectId whose transcription is updated (looked up by appointment_id).

Body Parameters

array
required
Replacement array of transcript segment objects, e.g. { "sender": "speaker_0", "message": "...", "start_time": "00:00:05,800" }. This fully replaces the existing transcription array. A non-array value is rejected (500).

Response

boolean
required
Indicates whether the transcription was updated successfully.
object
The updated transcription record.
Additional fields (for example __v) may appear on the transcription object. Treat any field not documented here as opaque.

Example Request

Example Response

Success (200)

Error Responses

401 Unauthorized
404 Transcription Not Found
404 Associated Appointment Not Found
The Unauthorized response uses the message field; handler-level errors use the error field. Unexpected server errors — including sending a non-array transcription value — return 500 { "success": false, "error": "<message>" }.

Behavior Notes

  • Full replacement: The supplied array completely replaces the existing transcription.
  • Update order: The transcription is updated first; if the appointment is then not found, the endpoint returns 404 Associated appointment not found. (the transcription is still updated).
  • Status reset: The appointment status is set to processing unconditionally and its error reason is cleared.
  • Note generation: Updating a transcription may re-trigger clinical note generation in the background; this does not change the HTTP response.