Instance Segment API

The Segment API from Instance — 1 operation(s) for segment.

OpenAPI Specification

instance-segment-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Robot rollout verifier Archive Segment API
  version: 0.1.0
tags:
- name: Segment
paths:
  /api/segment:
    post:
      summary: Segment Endpoint
      description: 'Synchronous multi-rollout batch (kept for scripts/curl; the UI uses

        /api/verify/start). Per-result shape is a strict superset of an /api/h1

        result (plus rollout_index/start_time/end_time/note), so the frontend card

        renderer and the download summary consume it unchanged.'
      operationId: segment_endpoint_api_segment_post
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_segment_endpoint_api_segment_post'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      tags:
      - Segment
components:
  schemas:
    Body_segment_endpoint_api_segment_post:
      properties:
        task:
          type: string
          title: Task
        files:
          anyOf:
          - items:
              type: string
              contentMediaType: application/octet-stream
            type: array
          - type: 'null'
          title: Files
        frames:
          type: integer
          title: Frames
          default: 8
        tokens:
          type: string
          title: Tokens
      type: object
      required:
      - task
      title: Body_segment_endpoint_api_segment_post
    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