The Summary API extracts key sentences from articles to provide a concise summary of the content.
All requests must be authenticated with your API key using a Bearer token:
Authorization: Bearer YOUR_API_KEY
Each successful Summary API call uses 10 credits.
To extract key sentences from an article, perform a POST request to the following URL:
| Parameter | Type | Description |
|---|---|---|
url |
string | URL of the article to summarize (required). |
content |
string | (Optional) HTML content to parse instead of fetching from URL. |
use_cache |
bool | (Optional) Specify if use of cache is permitted. Defaults to true. If set to false, the cache is bypassed. |
stream |
bool | (Optional) Stream the summary response. Defaults to false. |
On success, the API returns a JSON dictionary containing the following keys:
| Key | Description |
|---|---|
key_sentences |
Array of key sentences extracted from the article |
summary |
Concise summary of the article |
Possible status codes:
| Code | Reason |
|---|---|
| 200 | Success |
| 400 | Parameter missing or malformed |
| 401 | API key is invalid |
| 403 | Account suspended (payment error) |
| 409 | Exceeded monthly calls (Trial plan only) |
| 412 | Upstream parsing error or invalid response from parser |
| 429 | Rate limit exceeded |