> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bota.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Video Summary

> Retrieve a video summary result

<Info>
  This feature is **Coming Soon** and not yet available.
</Info>

## Overview

Retrieves a video summary by ID. Poll until `status` is `completed`, or listen for the `video_summary.completed` webhook.

## Authentication

Requires a valid API key with `video_summaries:read` scope.

## Path Parameters

<ParamField path="id" type="string" required>
  Video summary ID (e.g., `vs_abc123`)
</ParamField>

## Response

<ResponseExample>
  ```json 200 — Completed theme={null}
  {
    "id": "vs_abc123",
    "recording_id": "rec_abc123",
    "status": "completed",
    "keyframes": [
      {
        "media_id": "med_005",
        "timestamp_ms": 15000,
        "caption": "Presenter shows architecture diagram on whiteboard with three-tier layout",
        "transcript_context": "At 0:15 — 'So here's our proposed architecture...'",
        "relevance_score": 0.95
      },
      {
        "media_id": "med_005",
        "timestamp_ms": 82000,
        "caption": "Close-up of database schema drawn on whiteboard",
        "transcript_context": "At 1:22 — 'The key tables are users, devices, and recordings'",
        "relevance_score": 0.88
      },
      {
        "media_id": "med_009",
        "timestamp_ms": 5000,
        "caption": "Team gathered around table reviewing printed report",
        "transcript_context": "At 3:45 — 'Let's look at last quarter's numbers'",
        "relevance_score": 0.82
      }
    ],
    "overview": "15-minute walkthrough of proposed system architecture, covering API gateway, worker queues, and database schema. Ends with quarterly review discussion.",
    "media_count": 3,
    "created_at": "2025-01-15T11:00:00Z",
    "completed_at": "2025-01-15T11:01:30Z"
  }
  ```

  ```json 200 — Pending theme={null}
  {
    "id": "vs_abc123",
    "recording_id": "rec_abc123",
    "status": "pending",
    "keyframes": null,
    "overview": null,
    "media_count": 3,
    "created_at": "2025-01-15T11:00:00Z",
    "completed_at": null
  }
  ```
</ResponseExample>

## Response Fields

| Field                            | Type           | Description                                               |
| -------------------------------- | -------------- | --------------------------------------------------------- |
| `id`                             | string         | Video summary identifier (`vs_*`)                         |
| `recording_id`                   | string         | Source recording (`rec_*`)                                |
| `status`                         | string         | `pending`, `processing`, `completed`, `failed`            |
| `keyframes`                      | array \| null  | Extracted key frames with captions (null until completed) |
| `keyframes[].media_id`           | string         | Source video media (`med_*`)                              |
| `keyframes[].timestamp_ms`       | integer        | Frame timestamp within the video in milliseconds          |
| `keyframes[].caption`            | string         | AI-generated description of the frame                     |
| `keyframes[].transcript_context` | string \| null | Correlated transcript segment                             |
| `keyframes[].relevance_score`    | number         | Importance score (0–1)                                    |
| `overview`                       | string \| null | Overall narrative summary of the video content            |
| `media_count`                    | integer        | Number of video items processed                           |
| `created_at`                     | string         | Creation timestamp (ISO 8601)                             |
| `completed_at`                   | string \| null | Completion timestamp (ISO 8601)                           |

## Webhooks

| Event                     | Description                         |
| ------------------------- | ----------------------------------- |
| `video_summary.completed` | Video summary finished successfully |
| `video_summary.failed`    | Video summary encountered an error  |