Skip to main content
PUT
/
projects
/
{project_id}
/
summarization_settings
Update script settings
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."
}
'
import requests

url = "https://api.beyondwords.io/v1/projects/{project_id}/summarization_settings"

payload = {
"enabled": True,
"prompt": "Summarize the provided article text. Aim for a summary of about 250-300 words."
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: true,
prompt: 'Summarize the provided article text. Aim for a summary of about 250-300 words.'
})
};

fetch('https://api.beyondwords.io/v1/projects/{project_id}/summarization_settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.beyondwords.io/v1/projects/{project_id}/summarization_settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'prompt' => 'Summarize the provided article text. Aim for a summary of about 250-300 words.'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.beyondwords.io/v1/projects/{project_id}/summarization_settings"

payload := strings.NewReader("{\n \"enabled\": true,\n \"prompt\": \"Summarize the provided article text. Aim for a summary of about 250-300 words.\"\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.beyondwords.io/v1/projects/{project_id}/summarization_settings")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"prompt\": \"Summarize the provided article text. Aim for a summary of about 250-300 words.\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/projects/{project_id}/summarization_settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"prompt\": \"Summarize the provided article text. Aim for a summary of about 250-300 words.\"\n}"

response = http.request(request)
puts response.read_body
{
  "enabled": true,
  "prompt": "Summarize the provided article text."
}
{
"code": 401,
"message": "Unauthorized"
}
{
"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 | null

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