Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
protocol

Get Session

Retrieve the current status of a session and, once processing finishes, its transcript and structured template results. The HTTP status code signals progress: 202 still processing, 200 completed, 206 completed with partial results, 410 expired, 404 not found. After calling End Session, poll this endpoint at ~1-second intervals until the status is no longer 202.

get/voice/v1/sessions/{session_id}

Path parameters

session_idstring required
Example:ses_abc123def456

Session ID returned by Create Session

Query parameters

document_idstring
Example:doc_9f8e7d6c

If provided, returns only that document's result — e.g. a document_id from Process Template — instead of all session documents.

Response

Session completed successfully

session_idstring
upload_urlstring

Audio upload URL for the session (HTTPS for chunked, wss:// for stream).

statusstring
created_atstring date-time
completed_atstring date-time nullable
model_usedstring nullable
language_detectedstring nullable

ISO 639-1 language code detected from the audio.

audio_files_receivedinteger
audio_filesstring[]
additional_dataobject
templatesobject[]

Template results as a list — one entry per generated document, each a single-key object keyed by template_id. A template that produces multiple documents appears multiple times, so this is a list rather than a map. Each inner object carries status, data, document_id, document_type, publish metadata (and a presigned_url when applicable).

transcriptstring nullable
patient_detailsobject nullable

Example response

{
  "status": "completed",
  "model_used": "pro",
  "language_detected": "en",
  "templates": [
    {
      "eka_emr_template": {
        "status": "success",
        "document_id": "doc_abc123",
        "document_type": "eka_emr_template",
        "data": {
          "chief_complaint": "cough and fever"
        },
        "publish": {}
      }
    },
    {
      "clinical_notes_template": {
        "status": "success",
        "document_id": "doc_def456",
        "data": {
          "assessment": "Acute bronchitis"
        },
        "publish": {}
      }
    }
  ]
}