API Documentation

Integrate our powerful summarization engine directly into your applications.

Integration Guide

1. Authentication

Obtain your API Key from the dashboard. This key must be included in the header of every request.

Authorization: Bearer xxxxxxxxxxxxxxxxxxxx

2. Select Your Mode

Choose the summarization algorithm that best fits your needs (Standard vs AI Advanced).

3. Make the Request

Send a POST request to our endpoint with your text and configuration.

Summarize Text

Generate a summary based on the provided text, mode, and length configuration.

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

Request Parameters

Parameter	Type	Required	Description
text	String	Required	The exact content you want to summarize. Min: 10 words, Max: 5000 words.
mode	Integer	Required	Selects the AI Model to use. 1. Standard Mode Uses the lightweight mini model. Faster and consumes fewer credits. Best for simple texts. 2. AI Advanced Uses the full logical model. Provides higher quality, human-like summaries.
percentage	Integer	Optional	Length control from `1` (Shortest) to `6` (Longest). Default: `4`
type	String	Optional	Output format style. `summary_2` (Headings & Points) `bullets` (Bullet Points) `best_line` (Single Best Line)

Example Request

cURL

curl --location 'https://www.summarizer.org/api/user/summarize' \
                                                        --header 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxx' \
                                                        --form 'mode="2"' \
                                                        --form 'text="Artificial Intelligence (AI) is a rapidly evolving field of computer science that focuses on creating systems capable of performing tasks that typically require human intelligence."' \
                                                        --form 'percentage="4"' \
                                                        --form 'type="summary_2"'

Response Format

Successful Response

{
    "result": "Artificial Intelligence is a field of computer science..."
}

Error Response

{
    "type": "invalid_request",
    "message": "Text must be greater than 10 words"
}

Invalid API key in the request headers:

{
    "type": "invalid_request",
    "message": "incorrect API key provided"
}

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.