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

# Get Frame Extraction

> Retrieve details about a specific frame extraction including its frames



## OpenAPI

````yaml GET /frames/{frame_extraction_id}
openapi: 3.0.0
info:
  title: Cloudglue API
  description: API for Cloudglue
  license:
    name: Apache License 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 0.7.8
servers:
  - url: https://api.cloudglue.dev/v1
security:
  - bearerAuth: []
paths:
  /frames/{frame_extraction_id}:
    get:
      tags:
        - Frames
      summary: Get a specific frame extraction
      description: Retrieve details about a specific frame extraction including its frames
      operationId: getFrameExtraction
      parameters:
        - name: frame_extraction_id
          in: path
          required: true
          description: The ID of the frame extraction to retrieve
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          description: Number of frames to return
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
        - name: offset
          in: query
          description: Offset from the start of the frames list
          required: false
          schema:
            type: integer
            minimum: 0
      responses:
        '200':
          description: Frame extraction details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrameExtraction'
        '404':
          description: Frame extraction not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: An unexpected error occurred on the server
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    FrameExtraction:
      type: object
      required:
        - frame_extraction_id
        - status
        - created_at
        - file_id
        - frame_extraction_config
      properties:
        frame_extraction_id:
          type: string
          format: uuid
          description: Unique identifier for the frame extraction job
        status:
          type: string
          enum:
            - pending
            - processing
            - completed
            - failed
          description: Status of the frame extraction job
        created_at:
          type: number
          minimum: 0
          description: Unix timestamp in milliseconds when the frame extraction was created
        file_id:
          type: string
          format: uuid
          description: ID of the file this frame extraction belongs to
        frame_extraction_config:
          $ref: '#/components/schemas/FrameExtractionConfig'
        frame_count:
          type: number
          minimum: 0
          description: >-
            Total number of frames extracted (only present when status is
            completed)
        data:
          type: object
          description: >-
            Frame data with pagination (only present when status is completed
            and frames exist)
          required:
            - object
            - total
            - limit
            - offset
          properties:
            object:
              type: string
              enum:
                - list
              description: Object type, always 'list'
            frames:
              type: array
              items:
                type: object
                required:
                  - id
                  - timestamp
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Unique identifier for the frame
                  timestamp:
                    type: number
                    description: Timestamp of the frame in seconds
                  thumbnail_url:
                    type: string
                    description: >-
                      URL of the CDN-hosted thumbnail for the frame if
                      thumbnails are enabled
              description: Array of extracted frames
            total:
              type: integer
              description: Total number of frames in this extraction
            limit:
              type: integer
              description: Number of frames returned in this response
            offset:
              type: integer
              description: Offset from the start of the frames list
    Error:
      required:
        - error
      type: object
      properties:
        error:
          type: string
    FrameExtractionConfig:
      type: object
      description: >-
        Configuration for frame extraction. Currently only supports uniform
        strategy.
      required:
        - strategy
      properties:
        strategy:
          type: string
          enum:
            - uniform
          description: Frame extraction strategy - currently only 'uniform' is supported
        uniform_config:
          $ref: '#/components/schemas/FrameExtractionUniformConfig'
          description: Configuration for uniform frame extraction
        thumbnails_config:
          $ref: '#/components/schemas/FrameExtractionThumbnailsConfig'
          description: Configuration for frame thumbnails. Optional.
        start_time_seconds:
          type: number
          minimum: 0
          description: >-
            Optional: The start time of the video in seconds to start extracting
            frames from
        end_time_seconds:
          type: number
          minimum: 0
          description: >-
            Optional: The end time of the video in seconds to stop extracting
            frames at
    FrameExtractionUniformConfig:
      type: object
      description: Configuration for uniform frame extraction
      properties:
        frames_per_second:
          type: number
          minimum: 0.1
          maximum: 30
          description: Number of frames to extract per second of video
        max_width:
          type: number
          minimum: 64
          maximum: 4096
          description: >-
            Maximum width of extracted frames in pixels. Aspect ratio is
            preserved.
    FrameExtractionThumbnailsConfig:
      type: object
      description: Configuration for frame thumbnails
      properties:
        enable_frame_thumbnails:
          type: boolean
          description: Whether to generate CDN-hosted thumbnails for extracted frames
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````