action.summarize

Request an on-demand AI summary of the conversation while transcription is still active.

This action is designed for use on active calls that have an existing transcription session running. You can send this action via the Call Commands REST API, or include it in a SWML section executed via transfer or execute during a call.

Create a summirzation at the start of the transcription session

If you want automatic summarization when the session ends instead, use ai_summary: true in the start action.

action.summarize

objectrequired

An object that contains the summarize parameters.

summarize Parameters

summarize.webhook

string

The webhook URI to be called. Authentication can also be set in the url in the format of username:password@url.

summarize.prompt

string

The AI prompt that instructs the AI model how to summarize the conversation. This guides the style and content of the generated summary.

Example: "Provide a bullet-point summary of the main topics discussed."

Object Example

YAML

live_transcribe:
  action:
    summarize:
      webhook: 'https://example.com/webhook'
      prompt: Summarize the key points of this conversation.

JSON

{
  "live_transcribe": {
    "action": {
      "summarize": {
        "webhook": "https://example.com/webhook",
        "prompt": "Summarize the key points of this conversation."
      }
    }
  }
}

Default Summarization

If the summarize action is called with a empty object, the default summarization prompt and webhook will be used.

YAML

live_transcribe:
  action:
    summarize: {}

JSON

{
  "live_transcribe": {
    "action": {
      "summarize": {}
    }
  }
}