> ## 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 a video poster frame



## OpenAPI

````yaml /openapi.json post /api/media/poster-frame
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/poster-frame:
    post:
      tags:
        - Media Tools
      summary: Extract a video poster frame
      operationId: extractPosterFrame
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PosterFrameRequest'
      responses:
        '200':
          $ref: '#/components/responses/MediaToolFiles'
          description: Generated files or queued media tool job
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/MediaToolFilesResponse'
                  - $ref: '#/components/schemas/AsyncMediaToolJobResponse'
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '402':
          $ref: '#/components/responses/Error'
        '413':
          $ref: '#/components/responses/Error'
        '429':
          $ref: '#/components/responses/Error'
components:
  schemas:
    PosterFrameRequest:
      allOf:
        - $ref: '#/components/schemas/ThumbnailRequest'
        - type: object
          properties:
            timestamp:
              type: number
              default: 1
            width:
              type: integer
              default: 1280
    MediaToolFilesResponse:
      type: object
      properties:
        files:
          type: array
          items:
            $ref: '#/components/schemas/MediaToolFile'
      required:
        - files
    AsyncMediaToolJobResponse:
      type: object
      properties:
        jobId:
          type: string
          format: uuid
        status:
          const: pending
        tool:
          type: string
          enum:
            - thumbnail
            - pdf-preview
            - image-to-pdf
            - strip-metadata
            - poster-frame
            - extract-audio
            - watermark
            - inspect
            - trim
            - gif
            - storyboard
            - transform
      required:
        - jobId
        - status
        - tool
    ThumbnailRequest:
      allOf:
        - $ref: '#/components/schemas/SingleFileRequest'
        - type: object
          properties:
            format:
              $ref: '#/components/schemas/ImageToolFormat'
            width:
              type: integer
              default: 512
            height:
              type: integer
              default: 512
            fit:
              type: string
              enum:
                - cover
                - contain
                - inside
              default: cover
            quality:
              type: integer
              minimum: 1
              maximum: 100
              default: 82
            timestamp:
              type: number
              description: Seconds into the video when the uploaded file is video.
    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
    Error:
      type: object
      properties:
        error:
          type: string
        upgradeUrl:
          type: string
      required:
        - error
    SingleFileRequest:
      allOf:
        - type: object
          properties:
            file:
              type: string
              format: binary
              description: Multipart upload input.
        - $ref: '#/components/schemas/RemoteSourceFields'
      description: Provide either file or sourceUrl.
    ImageToolFormat:
      type: string
      enum:
        - jpg
        - png
        - webp
        - avif
    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.
  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.

````