damdafa-com Video API

openapi: 3.2.0
info:
  title: Damdafa Com Video API
  version: 1.0.0
  description: 'Operations tagged Video across 2 of this provider''s published API definitions: mockupper-damdafa-com-openapi.json, mockupper-damdafa-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /mockupper
tags:
- name: Video
paths:
  /api/v1/video/generate:
    post:
      tags:
      - Video
      summary: Generate Video Endpoint
      description: Start a video generation job.
      operationId: generate_video_endpoint_api_v1_video_generate_post
      security:
      - HTTPBearer: []
      parameters:
      - name: ProviderId
        in: header
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/AUTH_PROVIDER'
          - type: 'null'
          title: Providerid
      - name: X-Provider-Id
        in: header
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/AUTH_PROVIDER'
          - type: 'null'
          title: X-Provider-Id
      - name: X-Device-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Device-Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VideoGenerateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoGenerateResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: Authentication failed
                error_code: unauthorized
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
        '500':
          description: Internal Server Error
          content:
            application/json:
              example:
                error: Internal server error
                error_code: internal_error
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: /mockupper
  /api/v1/video/project/{projectId}/job/{jobId}:
    get:
      tags:
      - Video
      summary: Get Video Job Endpoint
      description: Get a video generation job by ID.
      operationId: get_video_job_endpoint_api_v1_video_project__projectId__job__jobId__get
      security:
      - HTTPBearer: []
      parameters:
      - name: projectId
        in: path
        required: true
        schema:
          type: string
          title: Projectid
      - name: jobId
        in: path
        required: true
        schema:
          type: string
          title: Jobid
      - name: ProviderId
        in: header
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/AUTH_PROVIDER'
          - type: 'null'
          title: Providerid
      - name: X-Provider-Id
        in: header
        required: false
        schema:
          anyOf:
          - $ref: '#/components/schemas/AUTH_PROVIDER'
          - type: 'null'
          title: X-Provider-Id
      - name: X-Device-Id
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: X-Device-Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VideoDocument'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: Authentication failed
                error_code: unauthorized
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
        '500':
          description: Internal Server Error
          content:
            application/json:
              example:
                error: Internal server error
                error_code: internal_error
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
        '404':
          description: Not Found
          content:
            application/json:
              example:
                error: Resource not found
                error_code: not_found
              schema:
                $ref: '#/components/schemas/ErrorResponseSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    servers:
    - url: /mockupper
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ErrorResponseSchema:
      properties:
        error:
          type: string
          title: Error
          description: Human-readable error message
        error_code:
          type: string
          enum:
          - internal_error
          - unauthorized
          - forbidden
          - authentication_failed
          - access_denied
          - not_found
          - conflict
          - job_in_progress
          - rate_limit_exceeded
          - validation_error
          - quota_exceeded
          - premium_required
          - insufficient_balance
          - timeout
          - service_unavailable
          - external_service_error
          - auth_required
          - invalid_token
          - auth_failed
          - auth_or_device_required
          - verification_failed
          - signature_content_mismatch
          - cancelled
          - email_not_verified
          title: Error Code
          description: Machine-readable error code
        details:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Details
          description: Additional error details
      type: object
      required:
      - error
      - error_code
      title: ErrorResponseSchema
      description: Standard error response schema for OpenAPI documentation
    VideoDocument:
      properties:
        id:
          type: string
          title: Id
        projectId:
          type: string
          title: Projectid
        versionId:
          type: string
          title: Versionid
        status:
          $ref: '#/components/schemas/VIDEO_STATUS'
        prompt:
          type: string
          title: Prompt
        plan:
          anyOf:
          - $ref: '#/components/schemas/VideoPlanSchema'
          - type: 'null'
        videoUrl:
          anyOf:
          - type: string
          - type: 'null'
          title: Videourl
        thumbnailUrl:
          anyOf:
          - type: string
          - type: 'null'
          title: Thumbnailurl
        createdAt:
          type: string
          format: date-time
          title: Createdat
        updatedAt:
          type: string
          format: date-time
          title: Updatedat
        error:
          anyOf:
          - type: string
          - type: 'null'
          title: Error
        errorCode:
          anyOf:
          - type: string
          - type: 'null'
          title: Errorcode
      type: object
      required:
      - id
      - projectId
      - versionId
      - status
      - prompt
      - createdAt
      - updatedAt
      title: VideoDocument
      description: Firestore document structure for a video job.
    VideoGenerateRequest:
      properties:
        projectId:
          type: string
          title: Projectid
        versionId:
          type: string
          title: Versionid
        screenshotGroupId:
          anyOf:
          - type: string
          - type: 'null'
          title: Screenshotgroupid
          description: The screenshot group to use as context for the video.
        prompt:
          anyOf:
          - type: string
          - type: 'null'
          title: Prompt
          description: Optional specific user instruction/concept
        guideImageUrls:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Guideimageurls
        aspectRatio:
          $ref: '#/components/schemas/AspectRatio'
          description: Target orientation for the video
          default: '9:16'
      type: object
      required:
      - projectId
      - versionId
      title: VideoGenerateRequest
      description: Schema for the video generation API request.
    AUTH_PROVIDER:
      type: string
      enum:
      - firebase
      - google
      - apple
      title: AUTH_PROVIDER
    VideoPlanSchema:
      properties:
        plan:
          type: string
          title: Plan
          description: The creative concept and narrative plan for the video.
        steps:
          items:
            type: string
          type: array
          title: Steps
          description: Step by step execution breakdown.
        prompt_for_veo:
          type: string
          title: Prompt For Veo
          description: The highly detailed, visual prompt to be sent to the video generation AI.
        rationale:
          anyOf:
          - type: string
          - type: 'null'
          title: Rationale
          description: Reasoning behind the plan.
      type: object
      required:
      - plan
      - prompt_for_veo
      title: VideoPlanSchema
      description: Schema for the video generation plan structure output by the LLM.
    VideoGenerateResponse:
      properties:
        jobId:
          type: string
          title: Jobid
        status:
          type: string
          title: Status
      type: object
      required:
      - jobId
      - status
      title: VideoGenerateResponse
      description: Response returned immediately to the client.
    AspectRatio:
      type: string
      enum:
      - '9:19.5'
      - '3:4'
      - '9:16'
      - '16:9'
      title: AspectRatio
      description: Centralized canvas defaults for preview rendering.
    VIDEO_STATUS:
      type: string
      enum:
      - PENDING
      - PLANNING
      - GENERATING
      - COMPLETED
      - FAILED
      title: VIDEO_STATUS
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- mockupper-damdafa-com-openapi.json
- mockupper-damdafa-com-openapi.json