iTwin Studio API

iTwin Studio apps are built with iTwin.js, and hence rely on the iTwin.js API. iTwin Studio provides additional APIs to interact with the iTwin Studio session and to perform iTwin Studio specific actions.

Types of Apps

• Startup App - An app that defines a session, establishing the overall workflow of the application. Each iTwin Studio session contains one startup app and zero to many additional apps. The startup app owns the session’s configuration and startup options, and is responsible for iTwin navigation and selection and iModel navigation and download.
• App - An app that can be loaded into a Startup App. Apps have fewer privileges than Startup Apps.

API Packages

• Startup App
  • @bentley/studio-startup-apps-frontend-api
  • @bentley/studio-startup-apps-backend-api
• App
  • @bentley/studio-apps-frontend-api
  • @bentley/studio-apps-backend-api

API Reference

Generated API documentation can be viewed at following links in the Reference section.

• Apps Backend

• Apps Frontend

• Startup Apps Backend

• Startup Apps Frontend