> ## Documentation Index
> Fetch the complete documentation index at: https://wiz-myvocal.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a real-time session

> Read the live state, usage and lines of a real-time session.

Returns one owned session. This is also the reconnect read: it reports the current `epoch`, the
received/captured cursors and whether the socket is `accepting` audio.

### Path

<ParamField path="sessionId" type="string" required>
  The `sessionId` from create.
</ParamField>

### Header

<ParamField header="accessKey" type="string" required>
  API key for authentication.
</ParamField>

### Response

Successful REST calls return `{ code: 1, message, data }`. The fields below are inside `data`;
JSON downloads are the documented exception and return the transcript view directly.

<ResponseField name="code" type="number">`1` for success.</ResponseField>
<ResponseField name="message" type="string">Result message.</ResponseField>

<ResponseField name="data" type="object">
  <Expandable title="properties" defaultOpen>
    <ResponseField name="sessionId" type="string">
      The session id.
    </ResponseField>

    <ResponseField name="transcriptionId" type="string">
      The History id.
    </ResponseField>

    <ResponseField name="status" type="string">
      The session state while open, or the task status once closed (`COMPLETED`, `PARTIAL`, `FAILED`).
    </ResponseField>

    <ResponseField name="epoch" type="number">
      The current recording segment. A `usage.updated` with `rotate: true` means start a new segment with
      `session.resume`; the client then sends from the new epoch.
    </ResponseField>

    <ResponseField name="accepting" type="boolean">
      Whether the server is accepting audio for this session right now.
    </ResponseField>

    <ResponseField name="partial" type="string">
      The current temporary text for the open segment.
    </ResponseField>

    <ResponseField name="lines" type="array">
      The committed lines: `id`, `text`, `revisedText`, `languageCode`, `languageProbability` and
      `entities`, `words` and `characterAlignments`.
    </ResponseField>

    <ResponseField name="notices" type="array">
      Processing notices, for example `PROCESSING_STORAGE_NOT_APPLIED`. The absence of a notice does
      not guarantee that a storage preference was applied.
    </ResponseField>

    <ResponseField name="usage" type="object">
      `estimatedCharacters`, `billableCharacters`, `elapsedMs`, `sentSamples`, `receivedSamples` and
      `capturedSamples`, all **decimal strings**; `accepting` is a boolean.
    </ResponseField>
  </Expandable>
</ResponseField>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.