Instance Example API

The Example API from Instance — 1 operation(s) for example.

OpenAPI Specification

instance-example-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Robot rollout verifier Archive Example API
  version: 0.1.0
tags:
- name: Example
paths:
  /api/example/{key}:
    get:
      summary: Example Video
      description: 'Serve one built-in example clip so the frontend can load it into the

        normal upload flow and play it inline.'
      operationId: example_video_api_example__key__get
      parameters:
      - name: key
        in: path
        required: true
        schema:
          type: string
          title: Key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Example
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