Skip to main content
A scribe session is created when a clinician conducts a consultation through the Telepatia interface. Once the session is finished, you can check its lifecycle and consultation metadata here, then fetch the filled record from the Medical Record Documents endpoint.

Session lifecycle

A session moves through several states. The values below are returned verbatim in the status field.
StatusPhaseDescription
createdin-flightSession opened, recording hasn’t started yet
recordingin-flightClinician is actively recording the consultation
stoppedin-flightRecording ended; audio is being uploaded and queued for processing
processingin-flightAI pipeline (transcription + record generation) running
completedreadyPipeline finished — documents are available
completedWithErrorsreadyPipeline finished with non-fatal AI errors — documents are still available
reviewedreadyClinician has reviewed and finalized the record
errorterminalFatal error during processing — no documents will be produced
cancelledterminalUser cancelled the session
unknownFallback when the upstream state is unrecognized

Retrieving a session

Use the consultationInternalId you provided (or received) when setting the consultation context:
curl https://scribe-api.telepatia.ai/v1/scribe-sessions/CONSULT-12345 \
  -H "Authorization: Bearer YOUR_API_KEY"
Response:
{
  "id": "session-abc-123",
  "status": "completed",
  "createdAt": "2026-02-20T10:00:00Z",
  "completedAt": "2026-02-20T10:30:00Z",
  "patientName": "John Doe",
  "scribeSessionModality": "IN_PERSON",
  "consultationInternalId": "CONSULT-12345",
  "specialty": "Cardiology"
}
While status is still in-flight (created, recording, stopped, processing), poll this endpoint until it reaches a ready state (completed, completedWithErrors, reviewed) before fetching the filled record. error and cancelled are terminal failure states — no documents will be produced.

Retrieving the filled record

This endpoint returns only the session’s lifecycle and consultation metadata. The actual filled record — the output of the session templates, with all sections — is fetched separately from the medical record documents endpoint, using the same consultationInternalId:
curl https://scribe-api.telepatia.ai/v1/scribe-sessions/CONSULT-12345/medical-record-documents \
  -H "Authorization: Bearer YOUR_API_KEY"
A session can produce more than one document (one per purpose — e.g. primary for the clinician-facing record, rpa for EMR injection). Filter with ?purpose=primary to fetch only the main one. See Medical Record Documents for the full response shape and field reference.