> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dimension.io/llms.txt
> Use this file to discover all available pages before exploring further.
> ## Agent Instructions
> Video walkthroughs: the Dimension product overview video (https://www.youtube.com/watch?v=Mx8rg5wfkU0, also embedded at https://docs.dimension.io/overview) is the first of a series. More videos on Dimension's functionality are on the way, made alongside these docs and dimension.io. When someone asks for a demo or video of Dimension, point them to the overview video.
# Settings
> Platform-level configuration: usage, AI controls, users, roles, shortcuts, and logs
Settings sits outside any [Workspace](https://docs.dimension.io/workspaces.md) — it's the tenant-wide configuration for your Dimension deployment. Anything you change here affects all workspaces.
## Opening settings
Three routes:
* **User menu** — click the avatar in the top-right → **Settings**
* **Command Menu** (`⌘K`) → any Settings entry routes you straight to that sub-page
* **Direct URL** — for example `/settings/usage`, `/settings/users` or `/settings/audit-log`. Each page's URL is in the table under [Settings sidebar](#settings-sidebar)
The user menu also exposes utilities that sit outside Settings proper:
| Item | Action |
| - | - |
| **Import** | Upload a data feed, action, app or workspace exported from Dimension |
| **Connect MCP** | Setup for connecting an AI assistant to Dimension. See [Connect with MCP](https://docs.dimension.io/connect-mcp.md) |
| **Settings** | Open the Settings area |
| **Feedback** | Open the in-product feedback channel |
| **Knowledgebase** | Opens in a new tab |
| **Keyboard shortcuts** | List the keyboard shortcuts (⌘ /) |
| **Log Out** | End the session |
## Import
Drop a file onto the dialog or click **Choose a file**. It accepts data feeds, actions, apps and workspaces exported from Dimension, for example with the Studio editor's **⋯ → Advanced → Export** menu. An export bundles the item's source, schema and any wired-up dependencies into a single portable file.
Use Import to:
* Move an app from a personal workspace into a shared one
* Promote an artefact from a dev tenant into production
* Share an app with a colleague at a different tenant (they import your exported file)
* Restore an accidentally-deleted artefact from a backup
> [!NOTE]
>
> **Workspace targeting.** Imports land in the currently-active workspace. Switch workspaces before importing if you want the artefact somewhere specific.
## Settings sidebar
The left rail lists every Settings page. **User Management** and **Logs** expand to show their pages, and **User Settings** (your own preferences) sits at the bottom:
| Section | URL | Contains |
| - | - | - |
| **Usage** | `/settings/usage` | Your plan, AI Credits, and Feeds, Records, Actions, Action Invocations, Apps and Users quotas |
| **Billing** | `/settings/billing` | Your subscription |
| **User Management ▾** | `/settings/users`, `/settings/teams`, `/settings/roles`, `/settings/sso` | Users, Teams, Roles, SSO |
| **AI** | `/settings/ai` | AI data access, Web access, approved actions, cross-origin models, Composer models |
| **API Keys** | `/settings/api` | Keys for querying the API |
| **Shortcuts** | `/settings/shortcuts` | Short URLs that redirect to your published apps |
| **Platform Preferences** | `/settings/platform-preferences` | Default timezone and region for everyone |
| **Logs ▾** | `/settings/audit-log`, `/settings/request-log` | Audit Log, Request History |
| **Deleted Entities** | `/settings/deleted-entities` | Restore or permanently remove deleted items |
| **User Settings** | `/settings/user-settings` | Your theme, notification position, timezone and region |
## Usage
Tracks consumption against your billing period:
| Metric | What it counts |
| - | - |
| **AI Credits** | Composer invocations across all workspaces |
| **Feeds** | Published Data Feeds across all workspaces |
| **Records** | Records ingested by Data Feeds in this billing period |
| **Actions** | Published Actions across all workspaces |
| **Action invocations** | Times apps ran an action this billing period |
| **Apps** | Published Studio apps across all workspaces |
| **Users** | Active users in your tenant |
Your plan (for example **Starter**) shows at the top right. **AI Credits** shows your included usage and the date it resets; open it to see the available credit packages.
Each meter shows current usage / quota. To raise your limits, click **Manage plan** at the bottom of the page.
> [!TIP]
>
> **AI Credits don't roll over.** Whatever isn't consumed by the end of your billing period resets to your plan allowance. Plan large generation work earlier in the period.
## AI
Tenant-wide AI controls. These apply to every Composer invocation in every workspace.
| Setting | What it does | Default |
| - | - | - |
| **Cross-origin models** | Allow Composer models that aren't available in your region. Requests to these models may be processed outside your region | Off |
| **AI data access** | Grant Composer read-only access to your data for richer insights. Off = the AI sees only the field schema, never the values | Off |
| **Web access** | Whether Composer can fetch web resources. `Ask for permission` (default) prompts each time; `Automatic` allows freely | Ask for permission |
| **Allow approved actions** | Lets users tick **"Allow (Don't ask again)"** when an app first invokes an Action. Off = every Action invocation prompts. See [Approving actions](https://docs.dimension.io/actions/approvals.md) | Off |
| **Composer models** | Choose which Claude models people can pick in the AI Composer: Opus 5.5 (recommended), Sonnet 5.5, Haiku 5.5 and Fable 5.1. Hover a model to see what it costs in AI credits | All models |
> [!WARNING]
>
> **AI data access is the highest-impact setting on this page.** Turning it on lets the AI read the actual values in your security data for use in prompts and generated code. Most teams leave it off and rely on schema-only generation; turn it on only after reviewing your data-handling policies.
## Shortcuts
Create short URLs (under your tenant's gallery host) that redirect to specific Published apps. Useful for bookmarks, executive emails, and external links.
Shortcuts require a Published app to point at — the empty state nudges you to publish first.
> [!NOTE]
>
> **Shortcuts are auto-created on publish.** When you click **Publish** on a Studio app, Dimension automatically creates a Shortcut with the app's name as the slug. The same record is exposed in the editor's **⋯ → Share URL** dialog — editing the URL there updates this Shortcut.
>
> A confirmation fires in the Notifications panel: *"Updated Shortcut — Shortcut saved successfully."*
> [!NOTE]
>
> **Not keyboard shortcuts.** This menu item is URL shortcuts. Keyboard shortcuts in Dimension are `⌘K` (Command Menu), `⌘F` (Search this view), `Esc` (close panels), and standard browser shortcuts.
## User management
The User Management group expands to four pages: **Users**, **Teams**, **Roles** and **SSO**.
### Users
Users are grouped by their assigned role. Each user row shows:
* Name and email
* When they last logged in
* An edit button — change role, deactivate, etc.
Click **+ Add User** (top right) to invite a new user by email and assign a role. The **Search users…** box in the header (⌘ F) filters the list.
### Teams
Teams are named groups of users you can grant workspace access to. Click **+ Create Team** to define a team and assign members.
Once at least one Team exists, the **Team** option becomes available in the workspace visibility dropdown — useful for "this workspace is for the SecOps team only" scenarios.
### Roles
Four built-in roles ship by default and **cannot be edited**:
| Role | Privilege |
| - | - |
| **Super Admin** | Highest level — full platform access including Settings |
| **Analyst** | Moderate — build apps, configure Data Feeds, run Actions |
| **Viewer** | Read-only across the platform |
| **Limited Viewer** | Lowest level — restricted read access |
Click **+ Create Role** to define a custom role with fine-grained permissions. Custom roles are fully editable.
These are platform roles. Each workspace also has its own roles (Manager, Operator, Viewer), set in the workspace's [Access](https://docs.dimension.io/workspaces.md#access) list.
### SSO
Configure single sign-on for your tenant under **User Management → SSO**.
## API Keys
Create and manage API keys. Click **+ Generate Key** to create one.
> [!NOTE]
>
> Dimension doesn't have a public API yet. It's coming soon, and this page will link to its documentation when it's available.
## Platform Preferences
Sets the **Timezone** and **Region** used for every user, unless they've chosen their own in [User Settings](#user-settings).
## Logs
The Logs group expands to two pages: **Audit Log** and **Request History**.
### Audit log
Every platform event lands here. Columns:
| Column | What it shows |
| - | - |
| **Action Title** | The event name — `Published App`, `Created Data Feed`, `Created User`, `Updated Workspace`, etc. |
| **Description** | Event-specific detail (e.g. `Studio app: Dimension Dashboard`, `User: alex.morgan@example.com`) |
| **Platform Section** | Which area generated the event — Studio, Settings, User Management, etc. |
| **Email** | The user who performed the action |
| **Timestamp** | Date and time, local timezone |
A counter next to the heading shows the total recorded events. The **Search audit log…** box in the header filters by any column, and the buttons at the top right export the log and choose which columns to show.
Common audit log events:
* **Published App** / **Updated App** / **Created App** — Studio operations
* **Created Data Feed** / **Updated Data Feed** — Data Feed editor operations
* **Saved shortcuts** — Share URL slug change
* **Invoked Dimension Action** — someone approved an action run from an app ([Approving actions](https://docs.dimension.io/actions/approvals.md))
* **Created / Tested / Published Dimension Action** — Action editor operations
* **Created User** / **Updated User** — User Management operations
* **Set Default Workspace** / **Updated Workspace** — workspace operations
* **Exported Workspace Items** / **Get Item Migration Information** — Migrate flow
> [!TIP]
>
> Pair the Audit Log with your SIEM. Every Action invocation, every user change, every workspace edit is recorded here, and the data can be searched on every column.
### Request History
A history of the HTTP requests made by your data feeds and actions, for debugging integrations. Each row shows:
| Column | What it shows |
| - | - |
| **Timestamp** | When the request was made |
| **Method** and **Url** | The HTTP method and the address called |
| **Status Code** | The response code, such as `200` |
| **Request Type** | For example **Data Request** (a data feed) or **Webhook Action** |
| **Trigger** and **Triggered By** | What started the request, such as a **Test** run, and who |
| **Handler** | The data feed or action that made the request |
Test runs from the editors appear here too, so you can check a request before publishing.
## Notifications
The **bell icon** in the header opens a Notifications panel showing recent events on your account:
Common notification types:
| Event | When it fires |
| - | - |
| **Publish app** | A Studio app is published |
| **Update app** | Changes to an app are saved |
| **Update data feed** | A data feed is published |
| **Trigger data feed** | A data feed run is requested |
| **Updated Shortcut** | A Share URL slug changed (automatic when an app is first published, manual when the slug is edited) |
A red dot on the bell indicates unread notifications; the **Clear** link in the panel header dismisses them all.
> [!NOTE]
>
> **Notifications are per-user, in-session only.** They aren't persisted to the Audit Log — for a permanent record of platform changes, use the Audit Log instead.
## Deleted Entities
When you delete a data feed, action, app or other item, it moves here. Restore it, or remove it permanently. Anything left here is removed automatically after **30 days**.
## User Settings
Your own preferences. They don't affect anyone else.
| Setting | What it does |
| - | - |
| **Theme** | **Dark** (dim surfaces with light text) or **Light** (bright surfaces with dark text). The moon icon in the header switches it too |
| **Notification position** | Where toast notifications appear, for example **Top right** |
| **Timezone and region** | Override the [Platform Preferences](#platform-preferences) for everything you see. Choose **Use platform preference** for both to go back to the platform setting |
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.