> ## 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.

# List File Frame Extractions

> List all frame extractions for a specific file



## OpenAPI

````yaml GET /files/{file_id}/frames
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:
  /files/{file_id}/frames:
    get:
      tags:
        - Files
      summary: List frame extractions for a file
      description: List all frame extractions for a specific file
      operationId: listFileFrameExtractions
      parameters:
        - name: file_id
          in: path
          required: true
          description: The ID of the file
          schema:
            type: string
            format: uuid
        - name: limit
          in: query
          description: Number of frame extractions to return
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
        - name: offset
          in: query
          description: Offset from the start of the list
          required: false
          schema:
            type: integer
            minimum: 0
      responses:
        '200':
          description: List of frame extractions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FrameExtractionList'
        '404':
          description: File 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:
    FrameExtractionList:
      type: object
      required:
        - object
        - data
        - total
        - limit
        - offset
      properties:
        object:
          type: string
          enum:
            - list
          description: Object type, always 'list'
        data:
          type: array
          items:
            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)
          description: Array of frame extraction objects
        total:
          type: integer
          description: Total number of frame extractions matching the query
        limit:
          type: integer
          description: Number of items returned in this response
        offset:
          type: integer
          description: Offset from the start of the 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

````