Skip to content

Summarization

POST
/api/v1/ai/summarization
x-api-key
required
string

Your API key from account settings.

object
accountId
required
websiteId
required

The website ID you trained the AI on.

string
prompt
required

The input of the content you’d like summarized.

string
filterPII

Optionally you can filter any detected personal identifiable information. This means the response of this call will also not contain any PII.

boolean
instructionsTemplate

Can be either “EXTRACT_MAIN_QUESTION” or “EXTRACT_MULTIPLE_QUESTIONS”. If not set, we will generate a summary of the prompt.

string
Allowed values: EXTRACT_MAIN_QUESTION EXTRACT_MULTIPLE_QUESTIONS
responseLanguage

Use this to force a certain response language. If not set, we will automatically detect the language based on the prompt.

string

Generated summary.

object
statusCode
integer
Example
200
body

The generated summary text.

string
Example
{
"statusCode": 200,
"body": "Generated response."
}

Invalid request parameters.