CLI Flags Reference

openapi: 3.0.3
info:
  title: Livepeer Orchestrator Protocol (Reference)
  description: >
    Derived reference documentation for Gateway ↔ Orchestrator gRPC interfaces.
    This spec mirrors protocol messages for operator understanding only.
  version: v0-derived
servers:
  - url: https://{orchestrator-host}
    variables:
      orchestrator-host:
        default: orchestrator.example.com:8935

paths:
  /orchestrator/info:
    get:
      summary: Get Orchestrator service metadata
      description: >
        Logical representation of the OrchestratorInfo gRPC message.
        Gateways use this data to evaluate pricing, capabilities, and routing.
      responses:
        '200':
          description: OrchestratorInfo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrchestratorInfo'

components:
  schemas:
    OrchestratorInfo:
      type: object
      required: [transcoder, address, price_info, capabilities]
      properties:
        transcoder:
          type: string
          description: Public service URI reachable by Gateways
        ticket_params:
          $ref: '#/components/schemas/TicketParams'
        price_info:
          $ref: '#/components/schemas/PriceInfo'
        address:
          type: string
          format: hex
          description: ETH payout address
        capabilities:
          $ref: '#/components/schemas/Capabilities'
        auth_token:
          $ref: '#/components/schemas/AuthToken'
        hardware:
          type: array
          items:
            $ref: '#/components/schemas/HardwareInformation'
        storage:
          type: array
          items:
            $ref: '#/components/schemas/OSInfo'
        capabilities_prices:
          type: array
          items:
            $ref: '#/components/schemas/PriceInfo'

    TicketParams:
      type: object
      description: Probabilistic payment ticket configuration

    PriceInfo:
      type: object
      properties:
        pricePerUnit:
          type: integer
          description: Cost per pricing unit (Wei)
        pixelsPerUnit:
          type: integer
          description: Pricing granularity unit

    Capabilities:
      type: object
      description: Supported job types and codecs

    HardwareInformation:
      type: object
      description: GPU / CPU / RAM characteristics

    OSInfo:
      type: object
      description: Storage and OS characteristics

    AuthToken:
      type: object
      description: Optional gateway authentication metadata