Skip to content

Overview#

Account#

To create an account with Engine AI, visit our platform at https://platform.engineai.com/login.

Once logged in, you can create a Workspace directly from your account homepage or join an existing Workspace via an email invitation. To join an existing Workspace, please contact the Workspace Admin to request an invitation. From the homepage, you can view all the Workspaces you are a part of or create a new Workspace to develop or access apps within it.

Workspaces#

Your account can be associated with multiple Workspaces, and you can easily switch between them. Typically, each organisation requires only one Workspace. You can invite users to your Workspace to work together seamlessly. In the Workspace you can create and manage Apps, invite and manage Users and Groups, manage App Permission, view audit logs.

To create a new Workspace:

  1. Click the Create Workspace button on the homepage and specify a workspace name and slug.

  2. Afterward, you can invite users to join your Workspace via the Users page.

Apps#

Apps are the foundational building blocks of Engine AI, where you can connect data sources, create dashboards, and set up data agents.

To create an app:

  1. Ensure you have an Admin role within Workspace.

  2. Click the Create App button in the Workspace and specify the app name and slug.

Connectors#

Connectors help to access and integrate data from various external sources, such as databases, APIs, and cloud services. They serve as bridges between your applications and the data you need, allowing you to pull in, manipulate, and display information from multiple sources in one centralised location. Connectors make it easy to retrieve real-time data enabling you to make better, data-driven decisions without needing to manually import or export data.

To create a connector:

  1. Navigate to the App Management Page by selecting an app tile from the Apps Page within your Workspace.

  2. Open the Data Connectors tab and click the Create Data Connector button.

  3. Select the type of connector and provide the required details.

Dashboards#

A dashboard is the main interface for organising and displaying information in a structured layout. It acts as a central hub where you can arrange different elements—such as widgets, charts, tables, and cards—to visualise and manage data. The Dashboard class is essential for building interfaces, providing a container for all layout components and tools that make up the dashboard. Using this class, you can create, modify, and organise content, customising the dashboard to suit specific data and workflow needs.

To create a dashboard:

  1. Make sure that you created an app and set up a data connector within it.

  2. Use the Engine AI SDK to design and implement your dashboard. For detailed instructions on how to create a dashboard, please refer to our Dashboard Creation Guide.