Summarize Text API
SharpAPI
1000 atoms
AI tier
About
The Text Summarization API generates a summarized version of the provided content, ideal for creating concise marketing introductions from longer texts.
This API is perfect for developers working on content management systems, marketing tools, or news aggregation platforms. It automates content summarization, making it easier to generate brief and impactful summaries. Use cases include creating marketing summaries, enhancing news digest features, and improving content readability for users.
Select API Endpoints
Input(s)
API Playground
API Documentation
Summarize Text Submit Job
POST
https://api.apyhub.com/sharpapi/api/v1/content/summarize
Request example
Method:
POST
Content Type:
application/json
Request Body
Attribute | Type | Mandatory | Description |
---|---|---|---|
content | String | Yes | Provide the content to summarize. |
voice_tone | String | No | Specify the voice tone of the output. It can be adjectives like funny or joyous , or even the name of a famous writer . |
max_length | Number | No | Specify the maximum length of the summary in words. Eg. 100 |
language | String | No | Specify the language of the output, defaults to English |
Sample Response
HTTP Response Codes
The method may return one of the following HTTP status codes:
Status Code | Description |
---|---|
202 | The job was submitted successfully. |
401 | Required authentication information is either missing or not valid for the resource. |
400 | Invalid input - if the file is invalid or corrupted |
500 | If any unexpected error occurs while submitting the request. |
Authentication
All API requests to ApyHub services need to be authenticated. Currently we support
tokens
or basic authentication
mechanisms.
You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".Points to note:
- Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
- Use the
apy-token
as the header parameter to pass the token. - Use the
Authorization
header to send the basic authentication credentials.
Error codes
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents