Summarize
Generate configurable AI summaries at multiple depths.
A Summarization distills a document into a title and a summary, at the depth you choose.
Loading diagram…
- Adjustable Depth: choose between a brief overview and a detailed summary.
- Contextual Instructions: add instructions to steer the focus or the language of the summary.
🏗️ Configuration
A Summarization is an Operation: it parses the Document, then summarizes it.
| Parameter | Type | Default | Description |
|---|---|---|---|
length | string | medium | Summary depth: short, medium, or long. |
tier | string | fast | fast or accurate. See Operation Tiers. |
instructions | string | none | Extra instructions for the model. |
parsing | object | { "tier": "fast" } | How the Document is parsed: tier and pages. See Parse. |
perimeter | string | external | Where your data may go. See Perimeters. |
The model reads the first 10,000 characters of the parsed Document; when it is longer, the Output reports truncated: true.
🛠️ Summarize a Document
For every field and parameter, see the Summarizations reference.
Submit a Summarization
curl -X POST "https://api.axelered.com/v1/summarizations?wait=30" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "file=@/path/to/legal_policy.pdf" \
-F 'config={"length": "short", "parsing": {"tier": "accurate"}}'Once the Summarization is done, the summary is in its output:
{
"status": "done",
"output": {
"value": { "length": "short", "title": "...", "summary": "..." },
"truncated": false
}
}List, Read & Delete
- List Summarizations: newest first, optionally for one Document with
?documentId=. Lists leave out theoutput. - Read Summarization: status, credits and
output, with optionalwait. - Delete Summarization: hide a Summarization. Its Document is kept.