NAVNavbar
Logo
cURL php NodeJS Python cSharp

Content Generation – Text Summary API


This endpoint will provide you with statistical data based on the given text, such as the number of words and sentences, vocabulary density, and text readability.

Instead of ‘login’ and ‘password’ use your credentials from https://app.dataforseo.com/api-dashboard

<?php
// You can download this file from here https://cdn.dataforseo.com/v3/examples/php/php_RestClient.zip
require('RestClient.php');
$api_url = 'https://api.dataforseo.com/';
// Instead of 'login' and 'password' use your credentials from https://app.dataforseo.com/api-dashboard
$client = new RestClient($api_url, null, 'login', 'password');
$post_array = array();
// simple way to set a task
$post_array[] = array(
   "text" => "Removing [RequireHttps] does nothing but break the https redirection, and doesn't enforce an https url on my route. I've got one method which i want to expose over http and a different one over https. If i accidentally enter http in my url for the https-only method, it should redirect. It currently works as is, the problem is that there is an undocument (seemingly unrelated) setting I have to add to get it all working. And that is the SslPort thing",
   "language_name" => "English (United States)"
);
try {
   // POST /v3/content_generation/text_summary/live
   $result = $client->post('/v3/content_generation/text_summary/live', $post_array);
   print_r($result);
   // do something with post result
} catch (RestClientException $e) {
   echo "n";
   print "HTTP code: {$e->getHttpCode()}n";
   print "Error code: {$e->getCode()}n";
   print "Message: {$e->getMessage()}n";
   print  $e->getTraceAsString();
   echo "n";
}
$client = null;
?>

The above command returns JSON structured like this:

{
    "version": "0.1.20221214",
    "status_code": 20000,
    "status_message": "Ok.",
    "time": "0.9516 sec.",
    "cost": 0.001,
    "tasks_count": 1,
    "tasks_error": 0,
    "tasks": [
        {
            "id": "01061611-1535-0507-0000-17ffb2141dd8",
            "status_code": 20000,
            "status_message": "Ok.",
            "time": "0.8954 sec.",
            "cost": 0.001,
            "result_count": 1,
            "path": [
                "v3",
                "content_generation",
                "text_summary",
                "live"
            ],
            "data": {
                "api": "content_generation",
                "function": "text_summary",
                "text": "Removing [RequireHttps] does nothing but break the https redirection, and doesn't enforce an https url on my route. I've got one method which i want to expose over http and a different one over https. If i accidentally enter http in my url for the https-only method, it should redirect. It currently works as is, the problem is that there is an undocument (seemingly unrelated) setting I have to add to get it all working. And that is the SslPort thing",
                "language_name": "English (United States)"
            },
            "result": [
                {
                    "sentences": 5,
                    "paragraphs": 1,
                    "words": 82,
                    "characters_without_spaces": 373,
                    "characters_with_spaces": 453,
                    "words_per_sentence": 16.4,
                    "characters_per_word": 4.390243902439025,
                    "vocabulary_density": 0.7317073170731707,
                    "keyword_density": {
                        "the": 4,
                        "https": 4,
                        "is": 4,
                        "to": 3,
                        "and": 2,
                        "an": 2,
                        "url": 2,
                        "my": 2,
                        "one": 2,
                        "method": 2
                    },
                    "automated_readability_index": 7.448048780487806,
                    "coleman_liau_index": 8.209756097560977,
                    "flesch_kincaid_grade_level": 105.26100000000002,
                    "smog_readability_index": 3.1291,
                    "spelling_errors": 11,
                    "grammar_errors": 14
                }
            ]
        }
    ]
}

All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method. When setting a task, you should send all task parameters in the task array of the generic POST array. You can send up to 2000 API calls per minute.

You can specify the number of results you want to retrieve, filter and sort them.

Below you will find a detailed description of the fields you can use for setting a task.

Description of the fields for setting a task:

Field name Type Description
text string target text
required field
can contain from 1 to 10000 tokens
learn more about tokens on our help center
language_name string name of the text language
required field if you do not specify language_code
see the List of Languages for Content Generation Text Summary API
language_code string code of the text language
required field if you do not specify language_name
see the List of Languages for Content Generation Text Summary API
internal_list_limit integer maximum number of elements within internal arrays
optional field
you can use this field to limit the number of elements within the keyword_density array
default value: 10
tag string user-defined task identifier
optional field
the character limit is 255
you can use this parameter to identify the task and match it with the result
you will find the specified tag value in the data object of the response

As a response of the API server, you will receive JSON-encoded data containing a tasks array with the information specific to the set tasks.

Description of the fields in the results array:

Field name Type Description
version string the current version of the API
status_code integer general status code
you can find the full list of the response codes here
Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions
status_message string general informational message
you can find the full list of general informational messages here
time string execution time, seconds
cost float total tasks cost, USD
tasks_count integer the number of tasks in the tasks array
tasks_error integer the number of tasks in the tasks array returned with an error
tasks array array of tasks
        id string task identifier
unique task identifier in our system in the UUID format
        status_code integer status code of the task
generated by DataForSEO; can be within the following range: 10000-60000
you can find the full list of the response codes here
        status_message string informational message of the task
you can find the full list of general informational messages here
        time string execution time, seconds
        cost float cost of the task, USD
        result_count integer number of elements in the result array
        path array URL path
        data object contains the same parameters that you specified in the POST request
        result array array of results
            sentences integer number of sentences found in the target text
            paragraphs integer number of paragraphs found in the target text
            words integer number of words found in the target text
            characters_without_spaces integer number of characters without spaces found in the target text
            characters_with_spaces integer number of characters with spaces found in the target text
            words_per_sentence float average number of words per sentence in the target text
            characters_per_word float average number of characters per word in the target text
            vocabulary_density float vocabulary density of the target text
            keyword_density object keyword density of the target text
contains most common words and their count
            automated_readability_index float Automated Readability Index
            coleman_liau_index float Coleman–Liau Index
            flesch_kincaid_grade_level float Flesch–Kincaid Readability Index
            smog_readability_index float SMOG Readability Index
            spelling_errors integer number of spelling errors found in the target text
            grammar_errors integer number of grammar errors found in the target text

‌‌