Transcripts

The Transcripts API allows you to retrieve transcripts for completed calls in your organization. Transcripts include a summary and timestamped transcript lines with speaker identification.

Transcript Properties

Transcript Line Properties

Endpoint

Get Call Transcript

Retrieve the transcript for a specific call, including summary and all transcript lines.

GET /api/external/organization_users/{organization_user_id}/calls/{call_id}/transcript

Parameters

Example Request

curl -X GET "https://api.kismethealth.com/api/external/organization_users/101/calls/5/transcript" \
  -H "X-Client-ID: your-client-id" \
  -H "X-Client-Secret: your-client-secret" \
  -H "Content-Type: application/json"

Example Response

{
  "id": 1,
  "summary": "This was a follow-up consultation regarding the patient's recent lab results. The doctor reviewed blood pressure readings and adjusted medication dosage. The patient reported feeling better overall with improved energy levels. A follow-up appointment was scheduled for next month.",
  "is_final": true,
  "transcript_lines": [
    {
      "id": 101,
      "text": "Good morning! How have you been feeling since our last visit?",
      "start_time": 5.2,
      "end_time": 8.7,
      "display_name": "Dr. Sarah Smith"
    },
    {
      "id": 102,
      "text": "Much better, thank you. My energy levels have really improved.",
      "start_time": 9.1,
      "end_time": 12.4,
      "display_name": "John Doe"
    },
    {
      "id": 103,
      "text": "That's great to hear. Let me review your latest lab results.",
      "start_time": 13.0,
      "end_time": 16.5,
      "display_name": "Dr. Sarah Smith"
    },
    {
      "id": 104,
      "text": "Your blood pressure has come down nicely with the current medication.",
      "start_time": 17.2,
      "end_time": 21.3,
      "display_name": "Dr. Sarah Smith"
    },
    {
      "id": 105,
      "text": "That's good news. Should I continue with the same dosage?",
      "start_time": 22.0,
      "end_time": 25.1,
      "display_name": "John Doe"
    }
  ]
}

Error Responses

• 404 Not Found: Returned when:
  • The organization user does not exist or is not accessible
  • The call does not exist or is not accessible
  • No transcript exists for the specified call

Transcript Generation

Processing Timeline

• Transcripts are generated automatically after a call ends
• Initial transcripts may have is_final: false while processing continues
• Final transcripts are marked with is_final: true when processing is complete
• Transcript lines are ordered by start_time in ascending order

Summary Generation

• The summary field contains an AI-generated overview of the call
• Summaries are created after transcript processing is complete
• Summaries highlight key discussion points, decisions, and action items

Transcript Lines

Speaker Identification

• Each transcript line includes the display_name of the speaker
• Speaker identification is based on the call participant records
• Participants include both organization users (providers) and recipients (patients)

Timing Information

• start_time and end_time are in seconds from the beginning of the call
• Times can be used to synchronize transcript lines with call recordings
• Transcript lines are sequential and non-overlapping

Access Control

Permissions

• Users can only access transcripts for calls within their organization
• The authenticated user must have access to the specified organization user
• API clients are authenticated via X-Client-ID and X-Client-Secret headers

Availability

• Transcripts are only available after the call has ended
• Not all calls may have transcripts (e.g., very short calls, technical issues)
• Check for 404 errors to determine if a transcript is available