Documentation
Everything you need to get started with OpenTwin.
Quick start
How it works once twin management goes live
- 1Open the twin overview — not available yet
- 2Click "Create new twin"
- 3Enter name, company, and product type
- 4Your twin is available immediately
API reference
REST API documentation
Every twin offers the following API endpoints:
GET
/Identify the twin
GET
/api/v1/identity/Master data
GET
/api/v1/bom/v1/treeBill of materials
POST
/api/v1/documents/Upload document
Concepts
Understand the key concepts
OTID
OpenTwin ID, a globally unique identifier in the format OT-XXXX-XXXX-XXXX
Twin runtime
The container/service running per twin instance
BOM (as delivered)
Bill of materials at the time of delivery
Platform
Central management that creates, manages, and provisions twins
Architecture
Technical structure
opentwin/
platform/ — Central management (FastAPI + PostgreSQL)
twin-runtime/ — Code per twin (FastAPI + SQLite)
infrastructure/ — Docker, Pulumi
PythonFastAPINext.jsDockerPulumiPostgreSQL