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

# Poll a video



## OpenAPI

````yaml /openapi.yaml get /v1/videos/{id}
openapi: 3.1.0
info:
  title: Cherry Shot API
  version: 1.0.0
  description: >
    Generate studio-quality product photography and video ads programmatically.
    Authenticate with an API key (`Authorization: Bearer cs_...` or `x-api-key:
    cs_...`). Generation is asynchronous: create a shoot or video, then poll it
    until `status` is `completed`. Credits are charged the same as in the app.
servers:
  - url: https://ybhqmgyprapjxomdxifs.supabase.co/functions/v1/api
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
paths:
  /v1/videos/{id}:
    get:
      summary: Poll a video
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Video
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Video'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Video:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
          example: video
        status:
          type: string
          enum:
            - pending
            - submitted
            - generating
            - completed
            - failed
        video_url:
          type: string
          nullable: true
        credits_used:
          type: integer
        credits_remaining:
          type: integer
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
    BearerAuth:
      type: http
      scheme: bearer

````