Skip to main content
PUT
/
projects
/
{project_id}
/
summarization_settings
Update
curl --request PUT \
  --url https://api.beyondwords.io/v1/projects/{project_id}/summarization_settings \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "enabled": true,
  "prompt": "Summarize the provided article text. Aim for a summary of about 250-300 words."
}
'
{
  "enabled": true,
  "prompt": "Summarize the provided article text."
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
project_id
string
required

The numeric ID of your project

Body

application/json
​
enabled
boolean

When true, AI-powered summarization is enabled

​
model
enum<string>
Available options:
gpt-5-nano,
gpt-5-mini,
gpt-5,
gpt-5.1
​
prompt
string | null

Custom prompt for AI summarization generation

​
temperature
number | null

Controls randomness in AI summarization (0.0 = deterministic, 2.0 = very random)

Required range: 0 <= x <= 2
​
limit_token_usage
integer | null

Maximum number of tokens to use for AI summarization

Required range: 1 <= x <= 3000
​
template
object

Response

successful

​
enabled
boolean

When true, AI-powered summarization is enabled

​
prompt
string | null

Custom prompt for AI summarization generation

​
model
enum<string> | null
Available options:
gpt-5-nano,
gpt-5-mini,
gpt-5,
gpt-5.1
​
temperature
number | null

Controls randomness in AI summarization (0.0 = deterministic, 2.0 = very random)

Required range: 0 <= x <= 2
​
limit_token_usage
integer | null

Maximum number of tokens to use for AI summarization

Required range: 1 <= x <= 3000
​
template
object[] | null