Skip to content
OnTwins
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Select language
English
한국어
Menu
Overview
What is OnTwins?
The four apps
Core concepts
How data flows
Architecture
Deployment channels
Security model
Get started
Get started
Run OnTwins locally
Create a project
Send your first sample
Model your first entity
Wire and interpret the value
Build and publish a scene
See it in the Viewer
Next steps
Apps
Choosing an app
Data Hub
Data Hub
Concepts
Quickstart
Register an agent
Build an agent
Manage credentials
Configure a dataset
Assign units
Normalization
Retention and deadband
Owners and tags
Split a dataset
Verify ingest
Monitor ingest quality
Screen reference
Troubleshooting
Scenes Studio
Scenes Studio
Concepts
Quickstart
Models and entities
Import 3D assets
Place entities in space
Wire telemetry
Configure interpretation
Compose a scene
Add widgets
Use the instancer
Viewpoints and autoview
Overlays and lenses
Commit a revision
Publish a scene
Screen reference
Troubleshooting
Viewer
Viewer
Concepts
Quickstart
Open a scene
Navigate the scene
Use the time bar
Read alarms
Acknowledge and resolve
Send an operation
Review activity
Share a view
Screen reference
Troubleshooting
Admin Console
Admin Console
Concepts
Quickstart
Register an app
Invite a user
Organize with groups
Grant permissions
Roles and scopes
Service accounts
Preview a decision
Audit log
Tenant settings
Screen reference
Troubleshooting
Guides
Guides
Onboard a new site
Design a permission model
Model a facility
Integrate a data source
Design an alarm strategy
Control and commands
Operate many sites
Integrate a custom app
Develop
Overview
Quickstart
Concepts
Planes
Platform model
Relationships
Identity
Authentication
Permissions
Errors
Missing data
Data boundary
Licensing
How-to
Authenticate a session
List, filter, and paginate
Use TanStack Query
Subscribe to telemetry
Download files
Surface policy errors
Register a custom app
Provision a service account
Accept an invite
Onboard an agent
Build a custom viewer
Seed at scale
API Reference
Overview
HTTP API
Conventions
Authentication
Error codes
Authoring plane
Runtime plane
Control plane
Agent plane
SDK packages
api-client
render-engine
view-runtime
Glossary
Operate
Overview
Install
Requirements
Cloud
On-premises Docker
Bare metal
Air-gapped install
Run
Configuration
Database
Upgrade
Migrations
Backup and restore
Licensing
TLS and networking
Observability
Troubleshooting
Select theme
Dark
Light
Auto
Select language
English
한국어
Authoring plane
Draft — this page will cover: the authoring endpoints, their payloads, and their validation rules.