Skip to main content
GET
Get Session
Poll this after End Session at ~1-second intervals. The HTTP status code is the signal:
StatusMeaning
202Still processing — keep polling
200Done — transcript + templates (with document_id per template) in the body
206Done, but some templates failed
410Session expired
Pass ?document_id=<id> to return only that document’s result — e.g. a document_id from Process Template. Prefer not to poll? Register a webhook.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

session_id
string
required

Session ID returned by Create Session

Example:

"ses_abc123def456"

Query Parameters

document_id
string

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

Example:

"doc_9f8e7d6c"

Response

Session completed successfully

Returned with HTTP 200 when the session completed successfully.

session_id
string
upload_url
string

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

status
string
Example:

"completed"

created_at
string<date-time>
completed_at
string<date-time> | null
model_used
string | null
Example:

"pro"

language_detected
string | null

ISO 639-1 language code detected from the audio.

Example:

"en"

audio_files_received
integer
audio_files
string[]
additional_data
object
templates
object[]

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).

Example:
transcript
string | null
patient_details
object | null