---
title: "Generate video or audio summary from url"
method: GET
path: "/v1/summarize"
tags: ["open"]
---

# Generate video or audio summary from url

`GET /v1/summarize`

## Query parameters

- `url` string, required — The URL to the video (e.g., ?url=https://www.bilibili.com/video/BV1Sk4y1x7r2)
- `includeDetail` boolean

## Response `200`

Successful response

- object
  - `success` boolean, required
  - `id` string, required
  - `service` string, required
  - `sourceUrl` string, required
  - `htmlUrl` string, required
  - `summary` string
  - `costDuration` number, required
  - `remainingTime` number, required
  - `billingNote` string
  - `detail` union
    - object
      - `summary` string
      - `dbId` string
      - `id` string, required
      - `embedId` string
      - `pageId` string
      - `url` string, required
      - `rawLang` string
      - `translationUrls` object[]
        - `code` string, required
        - `url` string, required
      - `audioUrl` string
      - `playUrl` string
      - `type` 'bilibili' | 'youtube' | 'podcast' | 'douyin' | 'tiktok' | 'wechat-channels' | 'online-media' | 'url-media' | 'import-file' | 'local-video' | 'local-audio' | 'record-audio' | 'local-subtitle' | 'webpage' | 'meeting', required
      - `title` string, required
      - `cover` string
      - `author` string
      - `authorId` string
      - `duration` number, required
      - `publishedDate` unknown
      - `subtitlesArray` object[], nullable
        - `startTime` number, required — The start time of the subtitle item in seconds, e.g. 53.58
        - `end` number, required — The end time of the subtitle item in seconds, e.g. 65.08
        - `text` string, required — The text of the subtitle item
        - `index` number, required — The index of the subtitle item
        - `words` object[] — The words of the subtitle item
          - `start` number, required
          - `end` number, required
          - `text` string, required
          - `punctuation` string
        - `speaker_id` number, nullable — The speaker id of the subtitle item
        - `_isGrouped` boolean — Whether this subtitle is a grouped subtitle
        - `_originalSubtitles` unknown[] — Original subtitles that were grouped together
          - unknown
      - `descriptionText` string
      - `contentText` string
      - `aiImages` object[]
        - `startTime` number, required
        - `endTime` number, required
        - `image` string
        - `prompt` string, required
      - `chapters` object[]
        - `from` number, required
        - `to` number, required
        - `content` string, required
        - `type` number
        - `imgUrl` string
      - `local_path` string
      - `status` string
      - `isPaid` boolean
      - `isPreviewOnly` boolean
      - `sourceLevel` 'guest' | 'authenticated' | 'transcribed'
    - object
      - `dbId` string
      - `audioUrl` string, required
      - `playUrl` string
      - `videoUrl` string
      - `title` string, required
      - `cover` string, required
      - `duration` number, required
      - `subtitleUrl` string
      - `subtitlesArray` object[], nullable
        - `startTime` number, required — The start time of the subtitle item in seconds, e.g. 53.58
        - `end` number, required — The end time of the subtitle item in seconds, e.g. 65.08
        - `text` string, required — The text of the subtitle item
        - `index` number, required — The index of the subtitle item
        - `words` object[] — The words of the subtitle item
          - `start` number, required
          - `end` number, required
          - `text` string, required
          - `punctuation` string
        - `speaker_id` number, nullable — The speaker id of the subtitle item
        - `_isGrouped` boolean — Whether this subtitle is a grouped subtitle
        - `_originalSubtitles` unknown[] — Original subtitles that were grouped together
          - unknown
      - `translationUrls` object[]
        - `code` string, required
        - `url` string, required
      - `description` string, required
      - `format` string, required
      - `author` string
      - `publishedDate` string
      - `content` string, required
      - `authorId` string
      - `chapters` object[]
        - `from` number, required
        - `to` number, required
        - `content` string, required
        - `type` number
        - `imgUrl` string
      - `rawUrl` string, required
      - `rawHtml` string, required

## Other responses

- `400` — Invalid input data
- `401` — Authorization not provided
- `403` — Insufficient access
- `404` — Not found
- `500` — Internal server error

---

[API](https://skmtc.net/bibigpt/apis/bibigpt-openapi.md) · [All operations](https://skmtc.net/bibigpt/apis/bibigpt-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bibigpt/bibigpt-openapi/versions/6923ed89c442/schema)
