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

# Extract video frames

> Extract one or more still frames from a video using the standard media-tool request envelope.



## OpenAPI

````yaml /openapi.json post /api/media/video-frames
openapi: 3.1.0
info:
  title: Convertly API
  version: 1.0.0
  description: >-
    Convertly provides production API endpoints for media conversion,
    compression, Image CDN delivery, Forma AI, HLS/DASH video streaming, media
    tools, async jobs, workflows, webhooks, and Convertly Storage.
  license:
    name: Proprietary
    url: https://convertly.sh/terms
servers:
  - url: https://convertly.sh
security:
  - bearerAuth: []
  - apiKeyAuth: []
paths:
  /api/media/video-frames:
    post:
      tags:
        - Media Tools
      summary: Extract video frames
      description: >-
        Extract one or more still frames from a video using the standard
        media-tool request envelope.
      operationId: extractVideoFrames
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/VideoFramesRequest'
      responses:
        '200':
          $ref: '#/components/responses/MediaToolFiles'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
components:
  schemas:
    VideoFramesRequest:
      allOf:
        - $ref: '#/components/schemas/SingleFileRequest'
        - type: object
          properties:
            format:
              type: string
              enum:
                - jpg
                - png
                - webp
                - avif
              default: jpg
            quality:
              type: integer
              minimum: 1
              maximum: 100
              default: 86
            start:
              type: number
              minimum: 0
              default: 0
            duration:
              type: number
              minimum: 0
            fps:
              oneOf:
                - type: number
                  exclusiveMinimum: 0
                - type: string
                  enum:
                    - source
                    - native
            interval:
              type: number
              exclusiveMinimum: 0
            maxFrames:
              type: integer
              minimum: 1
              default: 300
            width:
              type: integer
              minimum: 1
              default: 1280
            height:
              type: integer
              minimum: 0
            download:
              type: boolean
              description: Required for a direct synchronous ZIP response.
            async:
              type: boolean
              description: Queue large exports and save the ZIP to Convertly Storage.
    SingleFileRequest:
      allOf:
        - type: object
          properties:
            file:
              type: string
              format: binary
              description: Multipart upload input.
        - $ref: '#/components/schemas/RemoteSourceFields'
      description: Provide either file or sourceUrl.
    MediaToolFilesResponse:
      type: object
      properties:
        files:
          type: array
          items:
            $ref: '#/components/schemas/MediaToolFile'
      required:
        - files
    Error:
      type: object
      properties:
        error:
          type: string
        upgradeUrl:
          type: string
      required:
        - error
    RemoteSourceFields:
      type: object
      properties:
        sourceUrl:
          type: string
          format: uri
          description: >-
            Remote HTTP(S) file input. Use instead of file for single-file
            tools.
        async:
          type: string
          enum:
            - 'true'
            - 'false'
          default: 'false'
          description: Set true to queue the media tool as a background job.
        background:
          type: string
          enum:
            - 'true'
            - 'false'
          description: Alias for async=true.
    MediaToolFile:
      type: object
      properties:
        filename:
          type: string
        mimeType:
          type: string
        originalSize:
          type: integer
        finalSize:
          type: integer
        downloadUrl:
          type: string
      required:
        - filename
        - mimeType
        - originalSize
        - finalSize
        - downloadUrl
  responses:
    MediaToolFiles:
      description: Generated media files
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MediaToolFilesResponse'
    Error:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Dashboard-generated Convertly API key. Keys currently begin with
        `cvly_`.
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: Alternative API key header for server-side clients.

````