Get Session Transcript By Id

Return a session’s transcript, and whether it is complete.

Transcript records reach the logs database through an asynchronous pipeline, so a read taken immediately after a session ends can return a short record. transcript_complete is true only when everything the session reported writing is present, across both the spoken transcript and the tool activity in actions. A caller that needs the whole record should re-request with exponential backoff until it is true, or until its own time limit passes, keeping the last response either way.

A time limit is required rather than optional. transcript_complete never turns true for a session still in progress, for a session on a channel that reports no expected count (only voice reports one today), or for a session that ended before the field was introduced - so a caller polling without a limit would never stop.

GET /api/v1/sessions/transcript/{session_id}

Typescript (SDK)

TypeScript

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.sessions.transcript.getById({
    sessionId: "<id>",
  });

  console.log(result);
}

run();

200

{
  "session_id": "<string>",
  "transcription": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "lang": "en-US",
      "source": "user",
      "text": "<string>",
      "stt_confidence": {
        "provider": "<string>",
        "model": "<string>",
        "utterance": 123,
        "utterance_source": "provider",
        "words": [
          {
            "word": "<string>",
            "confidence": 123,
            "start": 123,
            "end": 123
          }
        ],
        "words_truncated": true
      }
    }
  ],
  "actions": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "tool_name": "<string>",
      "tool_request": "<string>",
      "tool_result": "<string>",
      "tool_error": "<string>",
      "duration_ms": 123
    }
  ],
  "transcript_complete": true
}

Authorizations

Syllable-API-Key · string · header · required

Path Parameters

session_id · string · required

Response

200

application/json

Successful Response

Text transcript of a given session. For more information, see Console docs.

session_id · string · required

Internal ID of the session

transcription · SessionText · object[] · required

Transcriptions of all messages in the session

Show child attributes

actions · SessionAction · object[] · required

Tool invocations that occurred during the session

Show child attributes

transcript_complete · boolean · default: false

True when every record the session reported writing is present, across both the spoken transcript and the tool activity in actions. False means the record cannot be confirmed complete. Callers should re-request until this is true, or until their own time limit passes. A limit is required rather than advisable, because three of the cases behind a False never turn true: a session still in progress, a session whose channel reports no expected count - only voice does today, so this is every web chat, SMS and email session - and any session that ended before this field was introduced.

Example:

true