TL;DR: This is easy

Simple REST API.



Usage

We only have a single API endpoint. https://tldr.kmw.moe/api/summarize


POST — https://tldr.kmw.moe/api/summarize

Query Parameters

text (Required) — string — Text to summarize. Works best if markdown and HTML is removed before sending.

sentences (Optional) — int — Number of sentences to summarize to. Defaults to 5.

shorten (Optional) — bool — Attempt to shorten sentences. Uses language tool and English hueristics. Defaults to false.

Reponse

status — string — SUCCESS when a summary could be generated. FAILURE if a summary could not be generated.

summary — string — The text summarized to the number of requested sentences.

Sample Query
{
    text: "Welcome to my site! My site is about natural language processing. Natural language processing is cool.",
    sentences: 1
}
Sample Response
{
    status: "SUCCESS",
    summary: "My site is about natural language processing."
}