Text Summary

Generates a summary for the given text.

Text Summary (EXPERIMENTAL)

Perform text summarization.

Securityapi_key
Request
Request Body schema: application/json
required
text
required
string non-empty

The text content with UTF-8 text representation

ishtml
boolean
Default: false

A boolean flag that should be set to true if text is in HTML markup.

limit
integer >= 1

Attempt to restrict the summary to these many words or less.

random
number [ 0 .. 1 ]
Default: 0

Controls the amount of randomness in the generated text. Lowering this will result in the output to be more deterministic.

model
string
Default: "gpt4-o"

The generative model to use.

Enum: "gpt4-o" "gpt4-o-mini" "gpt4" "gpt4-t" "o1" "o1-mini"
Responses
200

200 response

post/text/summary
Request samples
application/json
{
  • "text": "Jupiter is the fifth planet from the Sun and the largest in the Solar System. It is a gas giant with a mass one-thousandth that of the Sun, but two-and-a-half times that of all the other planets in the Solar System combined. Jupiter is one of the brightest objects visible to the naked eye in the night sky, and has been known to ancient civilizations since before recorded history. It is named after the Roman god Jupiter.[19] When viewed from Earth, Jupiter can be bright enough for its reflected light to cast visible shadows,[20] and is on average the third-brightest natural object in the night sky after the Moon and Venus."
}
Response samples
application/json
{ }