Interface Guide

samtSQL features two user interfaces:

• A visual web interface
• A REST interface

Both interfaces enable users to query and manage data. The web interface offers additional functionality for account management, and for creating Personal Access Tokens (PATs). PATs enable access via the REST interface. Hence, users should initially log in via the visual interface, creating PATs for REST access if needed.

Visual interface

The visual interface is served at /app/. Users have to log in in order to access the interface. Login options include sending magic links to a user-provided email address, as well as several OAuth providers.

The web interface enables users to configure access to a PostgreSQL instance, to upload, inspect, and delete data, to execute queries with AI operators on their database, to create and manage PATs for REST-based access, to access account usage statistics, as well as to cancel their subscriptions.

The visual interface is described in more detail on the visual interface overview.

REST interface

The REST interface enables users to upload and manage data, and to analyze data via semantic SQL queries. All requests sent to REST endpoints require a PAT which can only be created in the web interface. Unlike the web interface, the REST interface does not offer functionality for account management.

The REST interface is described in more detail in the REST API reference.