API Documentation

Integrate our powerful summarization engine directly into your applications.

API Endpoint

POST: https://www.summarizer.org/api/user/summarize

Authentication

Authentication requires a valid API key. Include your API key in the request headers.

Authorization: Bearer YOUR_API_KEY

Request Parameters

Parameter	Type	Required	Description
`text`	string	Yes	The text content to be summarized. Must be at least 10 words long. Maximum word limit is 5000 words.
`mode`	integer	Yes	Summarization mode: `1` for standard (uses mini model) `2` for advanced (uses full model)
`percentage`	integer	No	Controls summary length on a scale of `1` to `6` (shortest to longest). Default is `4`.
`type`	string	No	Optional parameter to specify the summary format. Options: `summary_2` (Headings & Points) `bullets` (Bullet Points) `best_line` (Single Best Line)

Check User API Key

To check your API key, go to the My Account page.

Examples

1. Standard Summary (Mode 1)

{
  "mode": 1,
  "text": "Your long text here...",
  "percentage": 3
}

2. Advanced Summary (Mode 2) with Specific Type

{
  "mode": 2,
  "text": "Your long text here...",
  "type": "summary_2"
}

Successful Response

curl --location 'https://www.summarizer.org/api/user/summarize' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--form 'mode="2"' \
--form 'text="Your long text here..."' \
--form 'percentage="4"' \
--form 'type="summary_2"'

Response Format

Successful Response

{
  "result": "Summarized text content..."
}

Error Response

{
  "error": "Error message"
}

{
  "type": "error_type",
  "message": "Error description"
}

Common Errors (Status Codes)

Status	Error	Description
200	OK	Request successful.
401	Unauthorized	Invalid or missing API Key.
422	Unprocessable Entity	Validation failed (length, missing params).
429	Too Many Requests	Rate limit exceeded.
500	Internal Server Error	Something went wrong on our end.

Support

If you have any questions or need further assistance, please contact our support team.