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

# Get Video

> Retrieve the status and result of a video generation request. Since video generation is asynchronous (typically 1–5 minutes), poll this endpoint every 15–30 seconds until the `status` is `completed` and the `url` field contains the video URL.



## OpenAPI

````yaml GET /api/get-video
openapi: 3.0.1
info:
  title: Easy-Peasy.AI API
  description: >-
    OpenAPI Specifications for the Easy-Peasy.AI API.


    All API requests must be authenticated with an API key. Include the
    `x-api-key` API key in the request header with all requests. You can get the
    API key [here](https://easy-peasy.ai/settings/api).
  version: 1.0.4
servers:
  - url: https://easy-peasy.ai
security:
  - apiKeyAuth: []
paths:
  /api/get-video:
    get:
      summary: Get Video
      description: >-
        Retrieve the status and result of a video generation request. Since
        video generation is asynchronous (typically 1–5 minutes), poll this
        endpoint every 15–30 seconds until the `status` is `completed` and the
        `url` field contains the video URL.
      operationId: getVideo
      parameters:
        - name: x-api-key
          in: header
          required: true
          schema:
            type: string
          description: Your API key
          example: 27feb2bb-aeb4-4a83-9fb6-8f3f2a15885e
        - name: video_id
          in: query
          required: true
          schema:
            type: string
          description: The video ID returned from the Generate Video endpoint
      responses:
        '200':
          description: Video data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVideoResponse'
              examples:
                processing:
                  summary: Video still processing
                  value:
                    video:
                      id: 12345
                      prompt: A cat walking on the beach at sunset
                      url: ''
                      model: Veo 3.1 Fast
                      status: processing
                      created_at: '2025-01-15T10:30:00.000Z'
                      request:
                        duration: '5'
                        aspectRatio: '16:9'
                        isTextToVideo: true
                        isImageToVideo: false
                completed:
                  summary: Video completed
                  value:
                    video:
                      id: 12345
                      prompt: A cat walking on the beach at sunset
                      url: https://media.easy-peasy.ai/videos/abc123.mp4
                      model: Veo 3.1 Fast
                      status: completed
                      created_at: '2025-01-15T10:30:00.000Z'
                      request:
                        duration: '5'
                        aspectRatio: '16:9'
                        isTextToVideo: true
                        isImageToVideo: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Invalid API key
        '404':
          description: Video not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Video not found
components:
  schemas:
    GetVideoResponse:
      type: object
      properties:
        video:
          type: object
          properties:
            id:
              type: integer
              description: Video ID
            prompt:
              type: string
              description: The prompt used for generation
            url:
              type: string
              description: >-
                Video URL. Empty string while processing, populated when
                complete.
            model:
              type: string
              description: The model used for generation
            status:
              type: string
              enum:
                - processing
                - completed
              description: >-
                Current status. `processing` means the video is still being
                generated. `completed` means the video URL is ready.
            created_at:
              type: string
              format: date-time
            request:
              type: object
              description: The original request parameters
              properties:
                duration:
                  type: string
                aspectRatio:
                  type: string
                isTextToVideo:
                  type: boolean
                isImageToVideo:
                  type: boolean
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
          example: Invalid API key
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. Get yours at
        https://easy-peasy.ai/settings/api

````