Summarize text into English (Short, Detailed, or Structured JSON)
Summarize conversational transcripts or documents into concise, grounded English summaries. ### Summary Styles - **`short`**: 2-4 sentences executive summary capturing core intent and resolution. - **`detailed`**: 5-8 sentences comprehensive summary including nuances, dates, amounts, and outcomes. - **`structured`**: Strict JSON object with 6 standardized keys: - `summary`: High-level summary string. - `customer_issue`: Primary reason for contact (or null). - `sentiment`: Customer sentiment (`positive`, `neutral`, `frustrated`, `negative`, or null). - `resolution_status`: Status of resolution (`resolved`, `pending`, `escalated`, or null). - `next_action`: Agreed follow-up step (or null). - `important_entities`: Array of key names, products, or reference identifiers. ### Notes - **Output Language**: Summarization output is always generated in **English**, regardless of source language. - **Streaming**: Supported for `short` and `detailed` styles (`stream: true`). `structured` JSON must be requested synchronously without streaming.
api/v1/text/summarizeAuthorization
AuthorizationRequiredBearer <token>
In: header
Request Body
application/jsonRequireddomainAny properties in TextDomain
Optional industry vertical domain for vocabulary specialization. Defaults to 'general conversation' if omitted.
languageRequiredLanguage
Source language of the input text. Must be one of the 19 supported African or global languages. Output summary is always returned in English.
"Afrikaans" | "Amharic" | "Arabic" | "English" | "French" | "German" | "Hausa" | "Igbo" | "Isixhosa" | "Italian" | "Kinyarwanda" | "Sesotho" | "Setswana" | "Shona" | "Spanish" | "Swahili" | "Twi" | "Yoruba" | "Zulu"streamStream
If true, streams output tokens as Server-Sent Events (SSE) text/event-stream. Supported for translation, redaction, and short/detailed summarization. (Not supported for structured summarization).
falsestyleSummaryStyle
Summary format and length:
short: 2-4 sentences executive summary.detailed: 5-8 sentences comprehensive summary.structured: 6-key JSON object (summary,customer_issue,sentiment,resolution_status,next_action,important_entities). Note: Cannot stream.
"short"Value in: "short" | "detailed" | "structured"textRequiredText
Input transcript, dialogue, or document text to process.
1Summarization completed successfully.