Application API

TwinView

Clear API and contract surface for TwinView, grouped under the application instead of split across generic reference sections.

curated srv_twinview

Documentation Map

Authority

Service IDs:

srv_twinview

Repos: PlatformApplications/TwinView

Hosts:

https://twinview.app https://api.twinview.app

Dependencies: topolo-auth, topolo-platform

Depends on Topolo Auth: yes

Contract Source

Type: curated

Source: PlatformApplications/TwinView/apps/api/src/index.ts

Source exists: yes

TwinView exposes a worker-backed application API for properties, property-detail aggregates, units, capture jobs, twins, annotations, inspection tasks, uploads, public share views, and Matterport connection metadata.

API key scopes in Auth catalog: 21

Auth Requirements

No global OpenAPI security scheme is declared.

  • dashboard.read
  • properties.read (property:*)
  • properties.write (property:*)
  • units.read (property:*)
  • units.write (property:*)
  • capture_jobs.read
  • capture_jobs.write
  • twins.read (property:*)
  • twins.write (property:*)
  • twins.publish (property:*)
  • annotations.read (property:*)
  • annotations.write (property:*)
  • inspections.read (property:*)
  • inspections.write (property:*)
  • share_views.read (property:*)
  • share_views.write (property:*)
  • integrations.read
  • integrations.write
  • reports.read
  • settings.read

Runtime and Deployment

Wrangler surfaces: PlatformApplications/TwinView/apps/api/wrangler.toml, PlatformApplications/TwinView/apps/web/wrangler.toml

Environment variables: ALLOWED_ORIGINS, APP_ORIGIN, ASSET_PUBLIC_BASE_URL, AUTH_BASE_URL

Routes: workers.dev or Pages-only delivery

Observability enabled: no explicit signal found

Package Surfaces

@twinview/api

No package description recorded.

Source: PlatformApplications/TwinView/apps/api/package.json

Scripts: build, typecheck, dev, deploy, deploy:dry-run, cf-typegen

@twinview/web

No package description recorded.

Source: PlatformApplications/TwinView/apps/web/package.json

Scripts: dev, build, preview, typecheck

twinview

No package description recorded.

Source: PlatformApplications/TwinView/package.json

Scripts: build, typecheck, dev:web, dev:api

@twinview/shared

No package description recorded.

Source: PlatformApplications/TwinView/packages/shared/package.json

Scripts: build, typecheck

@topolo/auth-client

Shared authentication client for Topolo applications

Source: PlatformApplications/TwinView/packages/topolo-auth-client/package.json

Scripts: build, dev, typecheck

Runtime Surface

Wrangler surfaces: PlatformApplications/TwinView/apps/api/wrangler.toml, PlatformApplications/TwinView/apps/web/wrangler.toml

This application does not yet have a source-controlled OpenAPI spec in the docs platform. The current API page is derived from the registered contract source and repository surface.

Failure modes

  • Neither OpenAPI nor README-derived interface detail was found.