Skip to main content
POST
/
projects
/
{project_id}
/
content
/
{id}
/
summarize
Summarize content
curl --request POST \
  --url https://api.beyondwords.io/v1/projects/{project_id}/content/{id}/summarize \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "model": "gpt-4o-mini",
  "prompt": "<string>",
  "temperature": 123,
  "limit_token_usage": 123
}
'
import requests

url = "https://api.beyondwords.io/v1/projects/{project_id}/content/{id}/summarize"

payload = {
"model": "gpt-4o-mini",
"prompt": "<string>",
"temperature": 123,
"limit_token_usage": 123
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
model: 'gpt-4o-mini',
prompt: '<string>',
temperature: 123,
limit_token_usage: 123
})
};

fetch('https://api.beyondwords.io/v1/projects/{project_id}/content/{id}/summarize', 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}/content/{id}/summarize",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'model' => 'gpt-4o-mini',
'prompt' => '<string>',
'temperature' => 123,
'limit_token_usage' => 123
]),
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}/content/{id}/summarize"

payload := strings.NewReader("{\n \"model\": \"gpt-4o-mini\",\n \"prompt\": \"<string>\",\n \"temperature\": 123,\n \"limit_token_usage\": 123\n}")

req, _ := http.NewRequest("POST", 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.post("https://api.beyondwords.io/v1/projects/{project_id}/content/{id}/summarize")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"model\": \"gpt-4o-mini\",\n \"prompt\": \"<string>\",\n \"temperature\": 123,\n \"limit_token_usage\": 123\n}")
.asString();
require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"model\": \"gpt-4o-mini\",\n \"prompt\": \"<string>\",\n \"temperature\": 123,\n \"limit_token_usage\": 123\n}"

response = http.request(request)
puts response.read_body
[
  {
    "section": "summary",
    "text": "Example text first",
    "content_type": "text"
  },
  {
    "section": "summary",
    "text": "Example text second",
    "content_type": "text"
  }
]

Authorizations

X-Api-Key
string
header
required

Path Parameters

project_id
string
required

project_id

id
string
required

id

Body

application/json
model
enum<string> | null

The model of AI. Possible values are gpt-4o-mini

Available options:
gpt-4o-mini
prompt
string | null

The AI prompt

temperature
number | null
limit_token_usage
integer | null

Response

200 - application/json

successful

section
string

The section type of the segment

content_type
enum<string>

The content type of the segment. Possible values are text, audio, or image. Images will appear in videos

Available options:
text,
audio,
image
text
string | null

The plain text for this segment. Required if content_type is text

audio_url
string | null

The URL of the uploaded audio file for this segment. Required if content_type is audio

image_url
string | null

The URL of the uploaded image file for this segment. Required if content_type is image