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

# Get Spoken Word Index

> Retrieve the spoken word index for semantic search

Retrieve metadata and status of the spoken word index for a video.

<CodeGroup>
  ```python Python theme={null}
  import videodb

  conn = videodb.connect(api_key="your_api_key")
  coll = conn.get_collection()
  video = coll.get_videos()[0]

  # The spoken word index is automatically created when indexing
  # Access it through search operations
  results = video.search("example query")

  print(f"Index is active and searchable")
  print(f"Found {len(results.docs)} results for the query")
  ```

  ```javascript Node.js theme={null}
  import { connect } from 'videodb';

  const conn = connect({ apiKey: 'your_api_key' });
  const coll = await conn.getCollection();
  const videos = await coll.getVideos();
  const video = videos[0];

  // The spoken word index is automatically created when indexing
  // Access it through search operations
  const results = await video.search('example query');

  console.log('Index is active and searchable');
  console.log(`Found ${results.docs.length} results for the query`);
  ```
</CodeGroup>

<Note>
  * Returns index metadata for spoken word semantic search
  * Use search() method to perform actual searches on the index
  * Requires index to be created first with create-index endpoint
  * Returns index status and configuration
  * Only index type currently supported is spoken\_word
</Note>


## OpenAPI

````yaml GET /video/{video_id}/index/
openapi: 3.0.3
info:
  title: VideoDB Server API
  description: >
    VideoDB Server API for video, audio, and image processing with AI
    capabilities.

    This API provides comprehensive video management, search, indexing, and
    AI-powered features.
  version: 1.0.0
  contact:
    name: VideoDB Support
    url: https://videodb.io
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.videodb.io
    description: Production server
  - url: https://staging-api.videodb.io
    description: Staging server
security:
  - ApiKeyAuth: []
tags:
  - name: Authentication
    description: User authentication and API key management
  - name: Collections
    description: Collection management operations
  - name: Videos
    description: Video upload, processing, and management
  - name: Audio
    description: Audio management operations
  - name: Images
    description: Image management operations
  - name: Search
    description: Content search and indexing
  - name: AI Generation
    description: AI-powered content generation
  - name: Billing
    description: Billing and usage management
  - name: RTStream
    description: Real-time streaming operations
  - name: Utilities
    description: Utility endpoints
  - name: Meeting
    description: Meeting recording and management
  - name: Capture
    description: Capture session management for recording streams
  - name: Editor
    description: Timeline editor operations
  - name: Transcode
    description: Media transcoding operations
  - name: Assets
    description: Cross-collection asset listing
paths:
  /video/{video_id}/index/:
    get:
      summary: Get video index status
      parameters:
        - name: video_id
          in: path
          required: true
          schema:
            type: string
            pattern: ^m-
            example: m-12345
        - name: index_type
          in: query
          required: true
          schema:
            type: string
            enum:
              - spoken_word
              - scene
            example: spoken_word
        - name: engine
          in: query
          schema:
            type: string
            default: default
            example: default
      responses:
        '200':
          description: Index status
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  status:
                    type: string
                    enum:
                      - done
                      - processing
                      - failed
                    example: done
                  message:
                    type: string
                    example: Index is available
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-access-token
      description: API key for authentication (sk-xxx format)

````