Skip to main content
GET
/
transcripts
/
{sessionId}
Get Transcript
curl --request GET \
  --url https://voice-livekit.studio.lyzr.ai/v1/transcripts/{sessionId} \
  --header 'x-api-key: <api-key>'
{
  "transcript": {
    "id": "<string>",
    "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "roomName": "<string>",
    "agentId": "<string>",
    "orgId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdByUserId": "<string>",
    "sessionReport": {},
    "chatHistory": [
      {}
    ],
    "closeReason": "<string>",
    "durationMs": 123,
    "messageCount": 123,
    "startedAt": "2023-11-07T05:31:56Z",
    "endedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.lyzr.ai/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve the full, granular record of a single Voice Agent conversation. While the List Transcripts endpoint is great for dashboards and overviews, this endpoint is used when you need to drill down into the exact turn-by-turn dialogue of a specific user interaction.
Authentication Required: You must include your API key in the x-api-key header. You can only fetch transcripts that belong to your organization or authorized scope.

​
Required Parameters

  • sessionId (Path Parameter): The unique UUID of the session you want to retrieve. You typically receive this ID when a session is first initiated, or you can find it by querying the List Transcripts endpoint.

​
Understanding the Transcript Document

When a session concludes, our engine compiles all the raw audio events, transcription data, and agent logic into a single JSON document. A successful 200 OK response will return a transcript object containing:
  • chatHistory: The exact sequence of messages exchanged between the human and the AI. This includes the parsed text of what the user said (via STT) and the text the LLM generated in response.
  • sessionReport: If your agent is configured to extract structured data (like a lead’s name, intent, or a summary of the call), that JSON data will appear here.
  • Core Analytics: Dive into exactly how the call performed using durationMs (length of the call), messageCount (how back-and-forth it was), and the timestamps (startedAt, endedAt).
  • closeReason: Understand exactly why the call ended. Was it an intentional hang-up, a network timeout, or did the agent gracefully conclude the conversation?

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
sessionId
string<uuid>
required

The unique UUID of the LiveKit session.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

Response

Transcript document retrieved successfully.

​
transcript
object