Summarization API

This documentation aims to give you all the details you require to use our summarising api service at paraphrasing.io.

Summarization API Documentation

This API was made primarily to help people use our content summarization tool more easily. By utilising our powerful AI tool with no training necessary, using our API will result in a quick summary of your content that maintains the original's main intent.

Just Getting Started?

Get can get authorization code after login to our platform. You can also generate or manage authorization codes.

Available languages

Our Summarization API available in 10+ languages: en id da de es fr it pl pt ro sv cs ru th ko

Authentication

To authenticate requests, the API authentication token is used. After logging in, you can view and manage your API Tokens in the Accounts page.

Your API keys have many privileges, so make sure to keep them safe! Do not share your secret API keys in public places like GitHub, client-side code, and so on.

All API requests must include a custom HTTP header called "authorization token." Each programming language's implementation is unique. Further below you can have Here are some examples.

HTTPS is required for all API requests. Calls made over plain HTTP will be rejected. API requests that do not include authentication will also fail.

Endpoints

Example Call

Below is example api call with CURL. You can follow the example to use out state of the art paraphrasing api endpoint. In this example a post HTTP call is initiate with required params and header with authenticate token.

                                            
1
2
3
4
5
6
7
8
9
10
                                            
curl --request POST \
        "https://www.paraphrasing.io/api/conversion/summarizeText" \
        --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
        --header "Content-Type: application/json" \
        --header "Accept: application/json
        --data-raw '{"paragraph":"{YOUR_TEXT}","lang":"en"}'

                                            
                                        

Returns

Below is a sample response from the endpoint

                                            
1
2
3
4
5
6
7
8
9
10
                                            
curl --request POST \
        "https://www.paraphrasing.io/api/conversion/summarizeText" \
        --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
        --header "Content-Type: application/json" \
        --header "Accept: application/json
        --data-raw '{"paragraph":"Leverage any of its four paraphrasing modes to rewrite the content as required. It enables you to rewrite the content using the standard, fluency, creative, or smarter paraphrasing modes, each of which resonates with a distinct writing style.","lang":"en"}'

                                            
                                        

                                            
1
2
3
4
5
6
7
8
9
10
                                            
 {"message": "success", 
     "content": [
             "Leverage any of its 4 paraphrasing modes to rewrite the content material as required. It permits you to rewrite the content material the use of the standard, fluency, creative, or smarter paraphrasing modes, every of which resonates with a wonderful writing style.",
             "Leverage any of its four paraphrasing modes to rewrite the content as required. It enables you to rewrite the content using the standard, fluency, creative, or smarter paraphrasing modes, each of which resonates with a distinct writing style.\n"
     ]
 }'

Rate Limiting

Each user has his or her own rate limit. When you join the club. Don't worry; you can always ask for more. When you hit a rate limit, the service will stop responding and will return the HTTP 429 response status code (Too many requests) for each request with the JSON string body text.

Error Codes

To indicate the success or failure of an API request, we use standard HTTP response codes. Generally speaking: Codes in the 4xx range indicate a client-side error, which means that the given information did not work (example: parameter missing, expired or missed authorization code). Codes in the 5xx range indicate a server error (which should not occur at all). If the response code is less than 200, the operation failed.

Response Codes

Success is indicated by codes in the 2xx range. If the response code is not 200, it means the operation failed in some way and you should take appropriate action.