Instance Clip API

The Clip API from Instance — 1 operation(s) for clip.

OpenAPI Specification

instance-clip-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Robot rollout verifier Archive Clip API
  version: 0.1.0
tags:
- name: Clip
paths:
  /api/clip/{clip_id}:
    get:
      summary: Clip Video
      description: 'Stream a clip''s retained source video (kept for the download button

        anyway) so the result card can play it under the live caption strip.

        FileResponse honors Range headers, so scrubbing works.'
      operationId: clip_video_api_clip__clip_id__get
      parameters:
      - name: clip_id
        in: path
        required: true
        schema:
          type: string
          title: Clip Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Clip
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