Sign in
Summaries

Update summary details

Update details for a summary. Note that this operation is only allowed for summary objects where sourceStatus is missing.

patch/summaries/{summaryId}/source

Path parameters

summaryIdstring required

The unique identifier of the summary source you want to update.

Request body

titlestring

A video title, based on the contents of the video.

abstractstring

A short outline of the contents of the video.

takeawaysstring[]

A list of 3 key points from the video, in chronological order.

Example request

{
  "title": "A short lecture on quantum theory",
  "abstract": "In this lecture, we discuss how complicated quantum theory is, using the famous example of Schrödingers cat. We also discuss practical applications like quantum computing.",
  "takeaways": [
    "Quantum theory is complicated.",
    "Schrödinger's cat is neither dead, nor alive.",
    "Quantum computers are super cool."
  ]
}

Response

Created

titlestring

A video title, based on the contents of the video.

abstractstring

A short outline of the contents of the video. The length of an abstract depends on the amount of content in a video that can be transcribed. The API condenses the contents into minimum 20, maximum 300 words.

takeawaysstring[]

A list of 3 key points from the video, in chronological order.

Example response

{
  "takeaways": [
    "Quantum theory is complicated.",
    "Schrödinger's cat is neither dead, nor alive.",
    "Quantum computers are super cool."
  ],
  "abstract": "In this lecture, we discuss how complicated quantum theory is, using the famous example of Schrödingers cat. We also discuss practical applications like quantum computing.",
  "title": "A short lecture on quantum theory"
}

Changes