Get project summarization settings

GET

projects

{project_id}

summarization_settings

Show

curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/summarization_settings \
  --header 'X-Api-Key: <api-key>'

{
  "enabled": true,
  "prompt": "Summarize the provided article text."
}

X-Api-Key

string

header

required

project_id

string

required

The numeric ID of your project

enabled

boolean

When true, AI-powered summarization is enabled

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

Show

curl --request GET \
  --url https://api.beyondwords.io/v1/projects/{project_id}/summarization_settings \
  --header 'X-Api-Key: <api-key>'

{
  "enabled": true,
  "prompt": "Summarize the provided article text."
}