Skip to main content
PUT
/
summarization_settings_templates
/
{slug}
Update script template
curl --request PUT \
  --url https://api.beyondwords.io/v1/summarization_settings_templates/{slug} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "name": "Test template new",
  "prompt": "Prompt example new",
  "temperature": 1.1,
  "limit_token_usage": 250
}
'
import requests

url = "https://api.beyondwords.io/v1/summarization_settings_templates/{slug}"

payload = {
"name": "Test template new",
"prompt": "Prompt example new",
"temperature": 1.1,
"limit_token_usage": 250
}
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({
name: 'Test template new',
prompt: 'Prompt example new',
temperature: 1.1,
limit_token_usage: 250
})
};

fetch('https://api.beyondwords.io/v1/summarization_settings_templates/{slug}', 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/summarization_settings_templates/{slug}",
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([
'name' => 'Test template new',
'prompt' => 'Prompt example new',
'temperature' => 1.1,
'limit_token_usage' => 250
]),
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/summarization_settings_templates/{slug}"

payload := strings.NewReader("{\n \"name\": \"Test template new\",\n \"prompt\": \"Prompt example new\",\n \"temperature\": 1.1,\n \"limit_token_usage\": 250\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/summarization_settings_templates/{slug}")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Test template new\",\n \"prompt\": \"Prompt example new\",\n \"temperature\": 1.1,\n \"limit_token_usage\": 250\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.beyondwords.io/v1/summarization_settings_templates/{slug}")

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 \"name\": \"Test template new\",\n \"prompt\": \"Prompt example new\",\n \"temperature\": 1.1,\n \"limit_token_usage\": 250\n}"

response = http.request(request)
puts response.read_body
{
  "id": 1,
  "name": "Test template 1",
  "slug": "test_template_1",
  "prompt": "Prompt example",
  "temperature": 1,
  "limit_token_usage": 500,
  "created": "2023-01-01 00:00:00 UTC",
  "updated": "2023-01-01 00:00:05 UTC"
}

Authorizations

X-Api-Key
string
header
required

Path Parameters

slug
string
required

The numeric ID of your summarization settings template

Body

application/json
slug
string
name
string
prompt
string
Maximum string length: 3000
temperature
number
Required range: 0 <= x <= 2
limit_token_usage
integer
Required range: 1 <= x <= 500
model
enum<string>
Available options:
gpt-5-nano,
gpt-5-mini,
gpt-5,
gpt-5.1

Response

200 - application/json

successful

id
integer
slug
string

Unique identifier for the object

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

Custom prompt for AI summarization generation

Maximum string length: 3000
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 <= 500