Summarization
POST /api/v1/ai/summarization
POST
/api/v1/ai/summarization
Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ” x-api-key
required
string
Your API key from account settings.
x-user-email
required
string
The email address of your user.
x-account-id
required
string
The ID of your account. You can find this in the account settings.
x-website-id
required
string
The ID of the workspace you want to use.
Request Body required
Section titled “Request Body required ”object
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
responseLanguage
Use this to force a certain response language. If not set, we will automatically detect the language based on the prompt.
string
Responses
Section titled “ Responses ”Generated summary.
object
statusCode
integer
Example
200 body
The generated summary text.
string
Example
{ "statusCode": 200, "body": "Generated response."}Invalid request parameters.