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

# Liveness and version



## OpenAPI

````yaml /openapi.yaml get /v1/health
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/health:
    get:
      summary: Liveness and version
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  name:
                    type: string
                  version:
                    type: string
                  status:
                    type: string
      security: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
    BearerAuth:
      type: http
      scheme: bearer

````