Extractive summary — the most representative sentences

Returns an extractive summary: the most important sentences of the text, kept in their original order.

Request

POSThttps://text-analysis.p.apihiver.com/v1/summarize

JSON object. Required: text.

Request Body

Edit the values below to test different scenarios.

Parameters and body structure are inherited from this endpoint's definition. Changes here only apply to this test run.

Language
Client
1curl --request POST \
2  --url https://text-analysis.p.apihiver.com/v1/summarize \
3  --header 'Accept: application/json' \
4  --header 'Content-Type: application/json' \
5  --header 'X-API-Key: YOUR_API_KEY' \
6  --data '{
7  "text": "APIHiver is a marketplace where developers discover, test and subscribe to APIs. Providers publish their APIs with documentation and pricing plans. The platform handles keys, billing and analytics so that developers can focus on building great products. Many teams love how simple it is.",
8  "sentences": 2
9}'

Extractive summary — the most representative sentences: Text Analysis API reference

Returns an extractive summary: the most important sentences of the text, kept in their original order. This endpoint is part of the Text Analysis API: Sentiment, keywords, extractive summaries, readability scores and text statistics for English text — one simple JSON call each.

Example response (200, application/json)

Success.

1{
2  "summary": "APIHiver is a marketplace where developers discover, test and subscribe to APIs. The platform handles keys, billing and analytics so that developers can focus on building great products.",
3  "sentences": [
4    "APIHiver is a marketplace where developers discover, test and subscribe to APIs.",
5    "The platform handles keys, billing and analytics so that developers can focus on building great products."
6  ],
7  "original_sentences": 4
8}

Errors

  • 400 — A required parameter is missing or a value has the wrong format.
    1{
    2  "error": {
    3    "code": "INVALID_INPUT",
    4    "message": "text: Field required"
    5  }
    6}

Gateway errors (missing key, no subscription, rate limits) are listed in Error codes.