Skip to main content
GET
/
transcripts
/
agent
/
{agentId}
List Transcripts by Agent
curl --request GET \
  --url https://voice-livekit.studio.lyzr.ai/v1/transcripts/agent/{agentId} \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "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"
    }
  ],
  "total": 42,
  "limit": 10,
  "offset": 0,
  "nextOffset": 10
}

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 a complete, paginated history of all conversations handled by a specific Voice Agent. If you have built multiple agents (e.g., one for Customer Support and another for Sales), this endpoint makes it incredibly easy to isolate the call logs for just one of those entities. This is the perfect endpoint to power an “Agent Performance” or “Recent Calls” view in your application’s dashboard.
Authentication Required: You must include your API key in the x-api-key header to authenticate this request.

​
Required Parameters

  • agentId (Path Parameter): The 24-character unique identifier of the agent whose transcripts you want to view.

​
Managing Large Datasets

Agents that handle high volumes of calls will quickly accumulate thousands of transcripts. Use the query parameters to control how much data you receive at once:
  • limit: Defines how many session records to return in a single response (default is usually 10 or 20).
  • offset: Allows you to skip a specific number of records. If your limit is 10, an offset of 10 will fetch page 2.
  • sort: Choose desc to see the most recently completed calls first, or asc to view them in the order they occurred historically.

​
Understanding the Response

A successful 200 OK response returns a standard pagination object.
  • items: An array containing the actual transcript objects. Each object includes the chatHistory, the sessionReport (if configured), and metadata like durationMs and messageCount.
  • total: The absolute total number of transcripts this agent has recorded.
  • nextOffset: A highly useful property that tells your frontend exactly what offset value to pass in your next API call to fetch the next page of results.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
agentId
string
required

The unique identifier of the agent.

Example:

"f790923795a23467555c0ad6"

Query Parameters

​
limit
integer

The maximum number of transcripts to return per page.

Example:

10

​
offset
integer

The number of items to skip for pagination.

Example:

0

​
sort
enum<string>

Sort order based on creation time.

Available options:
asc,
desc
Example:

"desc"

Response

200 - application/json

Paginated transcripts for the specified agent retrieved successfully.

​
items
object[]
​
total
integer
Example:

42

​
limit
integer
Example:

10

​
offset
integer
Example:

0

​
nextOffset
integer
Example:

10