Looking Glass Orchestration API

Multi-user Bridge sessions (orchestrations)

OpenAPI Specification

looking-glass-orchestration-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Looking Glass Bridge Autostart Orchestration API
  version: '1.0'
  description: 'HTTP REST API exposed by Looking Glass Bridge, the local runtime application that connects a host machine to Looking Glass holographic (light field) displays. Web and native applications call this local API to query connected displays, open the Bridge media player, build and control playlists of Quilt and RGBD holograms, and drive playback. The API is served on the loopback interface only (http://localhost:33334/); every operation is an HTTP POST with a JSON request body and returns a JSON envelope of the shape { "success": boolean, "response": object|null }. The official, typesafe way to consume this API is the @lookingglass/bridge (bridge.js) client library. This description was generated by the API Evangelist enrichment pipeline from Looking Glass''s public documentation and the open-source bridge.js client; endpoint signatures are, per the vendor, under active development.'
  contact:
    name: Looking Glass Factory
    url: https://lookingglassfactory.com
  x-generated-by: API Evangelist enrichment pipeline
  x-source:
  - https://docs.lookingglassfactory.com/software/looking-glass-bridge-sdk/web-application-integration
  - https://github.com/Looking-Glass/bridge.js
servers:
- url: http://localhost:33334/
  description: Looking Glass Bridge local loopback server (default port)
tags:
- name: Orchestration
  description: Multi-user Bridge sessions (orchestrations)
paths:
  /enter_orchestration:
    post:
      operationId: enter_orchestration
      summary: Start (or join) a Bridge orchestration session and receive an orchestration token
      tags:
      - Orchestration
      requestBody:
        $ref: '#/components/requestBodies/EnterOrchestration'
      responses:
        '200':
          $ref: '#/components/responses/Envelope'
  /exit_orchestration:
    post:
      operationId: exit_orchestration
      summary: Leave a Bridge orchestration session
      tags:
      - Orchestration
      requestBody:
        $ref: '#/components/requestBodies/Orchestrated'
      responses:
        '200':
          $ref: '#/components/responses/Envelope'
components:
  schemas:
    ResponseEnvelope:
      type: object
      description: Standard Bridge response envelope returned by every endpoint.
      properties:
        success:
          type: boolean
          description: Whether the operation succeeded.
        response:
          description: Operation payload when successful, otherwise null.
          type:
          - object
          - 'null'
      required:
      - success
    OrchestrationRef:
      type: object
      properties:
        orchestration:
          type: string
          description: Orchestration token returned by enter_orchestration.
      required:
      - orchestration
  requestBodies:
    Orchestrated:
      description: Requires the orchestration token for the session.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OrchestrationRef'
    EnterOrchestration:
      description: Optional orchestration name/keyword to create or join a session.
      content:
        application/json:
          schema:
            type: object
            properties:
              name:
                type: string
                description: Keyword identifying the orchestration to create or join.
  responses:
    Envelope:
      description: Standard Bridge response envelope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResponseEnvelope'