Summarize
Generate configurable AI summaries at multiple depths.
The Summarize module instantly generates structured summaries of your documents. It uses advanced language models to distill long-form content into concise, readable formats, allowing you to control the depth and focus of the output.
┌──────────────────────┐ ┌───────────────────────┐ ┌──────────────────────┐
│ 50-Page Legal Policy │ ────► │ Summarization Engine │ ────► │ 1-Page Summary │
└──────────────────────┘ │ (Level: "short") │ │ - Key point 1 │
└───────────────────────┘ │ - Key point 2 │
└──────────────────────┘- Adjustable Depth: Choose between brief overviews or detailed multi-paragraph summaries.
- Key Point Isolation: Explicitly request the most important bullet points for quick scanning.
- Cross-Language Summarization: Automatically summarize documents in English even if the source is in another language (configurable).
🏗️ Configuration
The Summarize module is defined within the summarizationConfig block.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
targetLength | string | medium | The desired summary depth: short, medium, or long. |
maxKeyPoints | int | 5 | The maximum number of key bullet points to generate. |
llmId | UUID | No | Reference to a pre-saved LLM configuration ID. |
llmConfig | object | No | Inline LLM configuration overrides. |
🛠️ Summarization Operations
Summarization is typically performed as part of a stateless process run. For a detailed technical reference of every field and parameter, see the API Process Reference.
Execute a Summarization Run
To generate summaries, submit a process request to your workspace with a summarizationConfig.
curl -X POST "https://api.axelered.com/v1/w/{workspace_id}/process" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"config": {
"summarizationConfig": {
"targetLength": "short",
"maxKeyPoints": 3
}
},
"files": [
{
"url": "https://example.com/legal_policy.pdf"
}
]
}'The summary will be available via the summaryUrl returned in the task documents list once the run reaches a completed state.
Read & List Summaries
To retrieve summaries for your documents, use the following endpoints:
- List Summaries: Retrieve all generated summaries for a complete run.
- Read Document Summary: Directly access the summary result for a specific document.