BEbeyondwords
Content

Summarize content

Generates a script summary for a content item using the project script settings.

post/projects/{project_id}/content/{id}/summarize

Request

  • Base URL
    https://api.beyondwords.io/v1
  • URL
    https://api.beyondwords.io/v1/projects/{project_id}/content/{id}/summarize
  • Auth
    API key in header X-Api-Key

Request body

model'gpt-4o-mini' nullable

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

promptstring nullable

The AI prompt

temperaturenumber nullable
limit_token_usageinteger nullable

Response

successful

sectionstring

The section type of the segment

content_type'text' | 'audio' | 'image' | 'video'

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

textstring nullable

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

audio_urlstring nullable

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

image_urlstring nullable

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

video_urlstring nullable

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

Changes

No recorded changes to this operation across all 2 revisions of this API.