Skip to main content

Text Summarizer is a simple tool for summarizing text. It returns a summary of the text.

Project description

Text Summarizer API

Text Summarizer is a simple tool for summarizing text. It returns a summary of the text.

Build Status Code Climate Prod Ready

This is a Python API Wrapper for the Text Summarizer API


Installation

Using pip:

pip install apiverve-textsummarizer

Using pip3:

pip3 install apiverve-textsummarizer

Configuration

Before using the textsummarizer API client, you have to setup your account and obtain your API Key. You can get it by signing up at https://apiverve.com


Quick Start

Here's a simple example to get you started quickly:

from apiverve_textsummarizer.apiClient import TextsummarizerAPIClient

# Initialize the client with your APIVerve API key
api = TextsummarizerAPIClient("[YOUR_API_KEY]")

query = {
    "text": "A news article can include accounts of eyewitnesses to the happening event. It can contain photographs, accounts, statistics, graphs, recollections, interviews, polls, debates on the topic, etc. Headlines can be used to focus the reader's attention on a particular (or main) part of the article. The writer can also give facts and detailed information following answers to general questions like who, what, when, where, why and how.",
    "sentences": 2
}

try:
    # Make the API call
    result = api.execute(query)

    # Print the result
    print(result)
except Exception as e:
    print(f"Error: {e}")

Usage

The Text Summarizer API documentation is found here: https://docs.apiverve.com/ref/textsummarizer. You can find parameters, example responses, and status codes documented here.

Setup

# Import the client module
from apiverve_textsummarizer.apiClient import TextsummarizerAPIClient

# Initialize the client with your APIVerve API key
api = TextsummarizerAPIClient("[YOUR_API_KEY]")

Perform Request

Using the API client, you can perform requests to the API.

Define Query
query = {
    "text": "A news article can include accounts of eyewitnesses to the happening event. It can contain photographs, accounts, statistics, graphs, recollections, interviews, polls, debates on the topic, etc. Headlines can be used to focus the reader's attention on a particular (or main) part of the article. The writer can also give facts and detailed information following answers to general questions like who, what, when, where, why and how.",
    "sentences": 2
}
Simple Request
# Make a request to the API
result = api.execute(query)

# Print the result
print(result)
Example Response
{
  "status": "ok",
  "error": null,
  "data": {
    "originalWords": 67,
    "summaryWords": 30,
    "percentDifference": 44.78,
    "summary": "A news article can include accounts of eyewitnesses to the happening event. Headlines can be used to focus the reader's attention on a particular (or main) part of the article."
  }
}

Error Handling

The API client provides comprehensive error handling through the TextsummarizerAPIClientError exception. Here are some examples:

Basic Error Handling

from apiverve_textsummarizer.apiClient import TextsummarizerAPIClient, TextsummarizerAPIClientError

api = TextsummarizerAPIClient("[YOUR_API_KEY]")

query = {
    "text": "A news article can include accounts of eyewitnesses to the happening event. It can contain photographs, accounts, statistics, graphs, recollections, interviews, polls, debates on the topic, etc. Headlines can be used to focus the reader's attention on a particular (or main) part of the article. The writer can also give facts and detailed information following answers to general questions like who, what, when, where, why and how.",
    "sentences": 2
}

try:
    result = api.execute(query)
    print("Success!")
    print(result)
except TextsummarizerAPIClientError as e:
    print(f"API Error: {e.message}")
    if e.status_code:
        print(f"Status Code: {e.status_code}")
    if e.response:
        print(f"Response: {e.response}")

Handling Specific Error Types

from apiverve_textsummarizer.apiClient import TextsummarizerAPIClient, TextsummarizerAPIClientError

api = TextsummarizerAPIClient("[YOUR_API_KEY]")

query = {
    "text": "A news article can include accounts of eyewitnesses to the happening event. It can contain photographs, accounts, statistics, graphs, recollections, interviews, polls, debates on the topic, etc. Headlines can be used to focus the reader's attention on a particular (or main) part of the article. The writer can also give facts and detailed information following answers to general questions like who, what, when, where, why and how.",
    "sentences": 2
}

try:
    result = api.execute(query)

    # Check for successful response
    if result.get('status') == 'success':
        print("Request successful!")
        print(result.get('data'))
    else:
        print(f"API returned an error: {result.get('error')}")

except TextsummarizerAPIClientError as e:
    # Handle API client errors
    if e.status_code == 401:
        print("Unauthorized: Invalid API key")
    elif e.status_code == 429:
        print("Rate limit exceeded")
    elif e.status_code >= 500:
        print("Server error - please try again later")
    else:
        print(f"API error: {e.message}")
except Exception as e:
    # Handle unexpected errors
    print(f"Unexpected error: {str(e)}")

Using Context Manager (Recommended)

The client supports the context manager protocol for automatic resource cleanup:

from apiverve_textsummarizer.apiClient import TextsummarizerAPIClient, TextsummarizerAPIClientError

query = {
    "text": "A news article can include accounts of eyewitnesses to the happening event. It can contain photographs, accounts, statistics, graphs, recollections, interviews, polls, debates on the topic, etc. Headlines can be used to focus the reader's attention on a particular (or main) part of the article. The writer can also give facts and detailed information following answers to general questions like who, what, when, where, why and how.",
    "sentences": 2
}

# Using context manager ensures proper cleanup
with TextsummarizerAPIClient("[YOUR_API_KEY]") as api:
    try:
        result = api.execute(query)
        print(result)
    except TextsummarizerAPIClientError as e:
        print(f"Error: {e.message}")
# Session is automatically closed here

Advanced Features

Debug Mode

Enable debug logging to see detailed request and response information:

from apiverve_textsummarizer.apiClient import TextsummarizerAPIClient

# Enable debug mode
api = TextsummarizerAPIClient("[YOUR_API_KEY]", debug=True)

query = {
    "text": "A news article can include accounts of eyewitnesses to the happening event. It can contain photographs, accounts, statistics, graphs, recollections, interviews, polls, debates on the topic, etc. Headlines can be used to focus the reader's attention on a particular (or main) part of the article. The writer can also give facts and detailed information following answers to general questions like who, what, when, where, why and how.",
    "sentences": 2
}

# Debug information will be printed to console
result = api.execute(query)

Manual Session Management

If you need to manually manage the session lifecycle:

from apiverve_textsummarizer.apiClient import TextsummarizerAPIClient

api = TextsummarizerAPIClient("[YOUR_API_KEY]")

query = {
    "text": "A news article can include accounts of eyewitnesses to the happening event. It can contain photographs, accounts, statistics, graphs, recollections, interviews, polls, debates on the topic, etc. Headlines can be used to focus the reader's attention on a particular (or main) part of the article. The writer can also give facts and detailed information following answers to general questions like who, what, when, where, why and how.",
    "sentences": 2
}

try:
    result = api.execute(query)
    print(result)
finally:
    # Manually close the session when done
    api.close()

Customer Support

Need any assistance? Get in touch with Customer Support.


Updates

Stay up to date by following @apiverveHQ on Twitter.


Legal

All usage of the APIVerve website, API, and services is subject to the APIVerve Terms of Service and all legal documents and agreements.


License

Licensed under the The MIT License (MIT)

Copyright (©) 2026 APIVerve, and EvlarSoft LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apiverve_textsummarizer-1.1.14.tar.gz (11.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

apiverve_textsummarizer-1.1.14-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file apiverve_textsummarizer-1.1.14.tar.gz.

File metadata

  • Download URL: apiverve_textsummarizer-1.1.14.tar.gz
  • Upload date:
  • Size: 11.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.10

File hashes

Hashes for apiverve_textsummarizer-1.1.14.tar.gz
Algorithm Hash digest
SHA256 4c1fa965e2fe300d56b1491ec5b5532e3b1b0df8ba0e60c66a5c141be1613c24
MD5 2f8156814f15e062896c127ce936ab14
BLAKE2b-256 5fb135fcf46b3e84a13244768fdda1ee0300439781dc282bd6fd0404986e39ba

See more details on using hashes here.

File details

Details for the file apiverve_textsummarizer-1.1.14-py3-none-any.whl.

File metadata

File hashes

Hashes for apiverve_textsummarizer-1.1.14-py3-none-any.whl
Algorithm Hash digest
SHA256 f355a6d80159aa19c51316bab63245182b87f5177250595a2e4447c602289bd4
MD5 cf0cc3f753c1ef3df9901773eae6edf0
BLAKE2b-256 9ad5a3eb51bff13b38c1726be8dfe7730e9ee3dcd58ef0486ccd9e49f279b752

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page