Summarization 1.0 Response

Response

The output contains information about the status of the request and the summary extracted. The information provided is the same for the different output formats and the naming convention used for all fields is lowercase_separated_by_underscore.

Response output

These are the fields included in the response document.

Name Description

Name	Description
`status`	Contains information about the extraction process and whether it has finished successfully. It is formed by a status code (`code`), a natural number that identifies the result, and a message (`msg`), a string describing the result. In addition, the field (`credits`) contains a natural number that indicates the credits consumed in the request and (`remaining_credits`) shows the number of credits left to the user to get to the credit limit. You can find all the possible status codes returned by the API with an explanation and tips on how to manage them in our error codes catalog. A request is any HTTP request done to the API to analyze less than 500 words. If the text sent is longer than that, then it will be considered that more than a request is made, more specifically, as many requests as we would need if the text were divided in chunks of 500 words. For instance, an HTTP request with 1013 words, will count as three requests, so 3 credits will be consumed; an HTTP request with a text 25648 words long would count as 25648/500 = 51.296 => 52 credits, and so on. Did you know...? Only the successful requests to the API will consume credits. In other words, the `credits` specified in the answer will only count as credits consumed when `code=0`.
`summary`	String of text with the summary extracted for the document.

status

Contains information about the extraction process and whether it has finished successfully. It is formed by a status code (code), a natural number that identifies the result, and a message (msg), a string describing the result. In addition, the field (credits) contains a natural number that indicates the credits consumed in the request and (remaining_credits) shows the number of credits left to the user to get to the credit limit.

You can find all the possible status codes returned by the API with an explanation and tips on how to manage them in our error codes catalog.

A request is any HTTP request done to the API to analyze less than 500 words. If the text sent is longer than that, then it will be considered that more than a request is made, more specifically, as many requests as we would need if the text were divided in chunks of 500 words.

For instance, an HTTP request with 1013 words, will count as three requests, so 3 credits will be consumed; an HTTP request with a text 25648 words long would count as 25648/500 = 51.296 => 52 credits, and so on.

Did you know...?

Only the successful requests to the API will consume credits. In other words, the credits specified in the answer will only count as credits consumed when code=0.

summary

String of text with the summary extracted for the document.

Response examples

The format in which this information will be shown will depend on the value of the of parameter.

https://en.wikipedia.org/wiki/Star_Trek

JSON
XML

{
  status: {
    code: "0",
    msg: "OK",
    credits: "25"
  },
  summary: "Star Trek is an American science fiction media franchise based on the television series created by Gene Roddenberry. The first television series, simply called, Star Trek, and now referred to as The Original Series, debuted in 1966 and aired for three seasons on the television network NBC. The Star Trek canon of the franchise includes The Original Series, an animated series, four spin-off television series, its film franchise and an upcoming television series scheduled to debut in 2017. In creating Star Trek, Roddenberry was inspired by the Horatio Hornblower novels, the satirical book Gulliver's Travels, and by works of western genre such as the television series Wagon Train. Four spin-off television series were eventually produced: Star Trek: The Next Generation followed the crew of a new starship Enterprise set a century after the original series; Star Trek: Deep Space Nine and Star Trek: Voyager set contemporaneously with The Next Generation; and Star Trek: Enterprise set before the original series in the early days of human interstellar travel."
}

<?xml version="1.0" encoding="utf-8"?>
<response>
  <status code="0" credits="25">OK</status>
  <summary>
    Star Trek is an American science fiction media franchise based on the television series created by Gene Roddenberry. The first television series, simply called, Star Trek, and now referred to as The Original Series, debuted in 1966 and aired for three seasons on the television network NBC. The Star Trek canon of the franchise includes The Original Series, an animated series, four spin-off television series, its film franchise and an upcoming television series scheduled to debut in 2017. In creating Star Trek, Roddenberry was inspired by the Horatio Hornblower novels, the satirical book Gulliver's Travels, and by works of western genre such as the television series Wagon Train. Four spin-off television series were eventually produced: Star Trek: The Next Generation followed the crew of a new starship Enterprise set a century after the original series; Star Trek: Deep Space Nine and Star Trek: Voyager set contemporaneously with The Next Generation; and Star Trek: Enterprise set before the original series in the early days of human interstellar travel.
  </summary>
</response>