POST
/
projects
/
{project_id}
/
content
/
{id}
/
summarize
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>"
}'
[
  {
    "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

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

Previous
Overview
Next