POST
/
v1
/
ai
/
summary

​
Body

​
text
string | string[]
required

The text to summarize. Maximum character is 300,000. Not required if file_store_key or url is specified.

​
type
string
default: "text"

The summary result type. Supported values are:

  • text - Returns a text summary.
  • points - Returns an array with points summary.
​
url
string

The PDF url. Not required if file_store_key or text is specified.

​
file_store_key
string

The key used to store the PDF on Jigsawstack file Storage. Not required if url or text is specified.

​
max_points
number
default: "2"

The maximum number of points to return. Maximum is 100.

​
max_characters
number

The maximum number of characters to summarize text into

​
x-api-key
string
required

Your JigsawStack API key

​
Response

​
success
boolean

Indicates whether the call was successful.

​
summary
string | array<string>

The summarized text.

Was this page helpful?

TranslatePrediction