Skip to content
AvraAvra
Esc
↑↓navigate↵open⌘Jpreview
On this page

Dashboard overview

How the dashboard at app.avra.ai is organized — your organization and its workspaces, the sidebar, and where to go for each task.

The dashboard at app.avra.ai is where your team manages everything around the API: models and their versions, batches, file exchange with Avra, alerts, logs, and who has access to what. Your systems call the API with keys created here, and the people on your team sign in here to set things up and keep an eye on them.

This page explains how the dashboard is organized, maps its sidebar, and points you to the guide for each task.

Get started

A first session usually follows these steps.

Sign in

Open app.avra.ai and sign in with your corporate email. The dashboard opens your organization, at the workspace you used last. See Authentication & sessions.

Invite your team

As a Creator, invite teammates under Settings → Organization → Members, and give each one a role. See Team management.

Create an API key

In the workspace your systems call, open Settings → Workspace → API keys and create a key. See API keys.

Try a model

Open Models, pick a model, read its schema, and select ⋯ → Run a prediction on a version to try it before you integrate. See Live predictions.

Watch usage and set up alerts

Follow every prediction under Observability → Usage, and choose how alerts reach you under Alerts → Notifications. See Audit and usage logs and Notifications.

Organizations and workspaces

An organization is your company’s account in Avra. It holds your members and billing, and its roles, models, notifications, and webhooks apply across it. Inside it are one or more workspaces: isolated areas, each with its own API keys, batches, files, and logs. Use them to keep production apart from sandbox work, or to give each business unit an area of its own.

Your organizationShared across every workspaceMembers and rolesBillingModelsNotificationsWebhooksWorkspaces, each isolated from the othersproductionworkspaceAPI keysBatchesUploads and exportsAudit and usage logssandboxworkspaceAPI keysBatchesUploads and exportsAudit and usage logs
An organization holds your members and their roles, billing, models, notifications, and webhooks. Each workspace inside it keeps its own API keys, batches, files, and logs.

Three things follow from this structure. A member’s role is set once, for the organization, and applies in every workspace, so there are no per-workspace roles. An API key belongs to one workspace, so a system that calls two workspaces needs a key from each. And the batches, files, and logs you see are those of the workspace you’re in: switch workspaces to see another’s.

The switcher at the top of the sidebar shows your organization, the workspace you’re in, and its environment, such as Prod. It lists the other workspaces and, under Switch organization, the other organizations you belong to. The header repeats the environment next to the breadcrumbs, so you always know whether you’re working in production. See Workspaces to create, rename, or archive one.

Find your way around

The sidebar lists the dashboard’s pages, named here as they appear in the app.

Sidebar What it’s for Guide
Overview Shortcuts to models, batches, and observability, and to the docs, the API reference, members, and notifications
Platform
Models Browse models, versions, schemas, and metrics. Select a version to see its metrics; its ⋯ menu runs a prediction and manages aliases Model versioning
Batches Create batch predictions from Parquet or CSV files, follow their progress, and download results Batch inference
File Transfer → Sent to Avra, File Transfer → Received from Avra Upload files for Avra, and download the files Avra prepares for you Preparing your data
Observability → Audit Account activity in the workspace: keys, members, workspaces, and configuration Audit and usage logs
Observability → Usage Every prediction the workspace served through the API or in batch Audit and usage logs
Alerts → Notifications How alerts reach you, and your organization’s shared destinations Notifications
Alerts → Webhooks Your organization’s webhook endpoints and their delivery history Webhooks
Settings Opens the settings home, with a card for each page below. Inside settings, a menu on the left moves between them
Workspace → General The workspace’s ID, name, and description, and archiving it Workspaces
Workspace → API keys The keys your systems use to call this workspace API keys
Organization → General Your organization’s profile details and logo
Organization → Members Invitations, roles, and removals Team management
Organization → Billing Your organization’s invoices, in the invoice portal

The sidebar shows what your role can use. Alerts → Webhooks appears only for roles that can manage webhooks, and File Transfer appears once Avra enables it for your organization, for roles that can download files. Other pages open for everyone, and show a notice or turn off the controls your role can’t use. See Roles & permissions.

The header shows where you are, as breadcrumbs. On its right, the Help & Feedback menu links to this documentation, the API reference, the changelog, and system status, and its Contact Support item reaches Avra’s support team. Next to it, the notification bell opens your in-app notifications.

Your name at the bottom of the sidebar opens the user menu. Account holds your profile and how you sign in, Dark Mode or Light Mode switches the theme, Switch organization is a shortcut to the same organizations as the switcher, and Log out ends your session.

Common tasks

Set up your team

Invite teammates under Settings → Organization → Members and give each one the narrowest role their work needs. Only Creators manage members, and every role can see who’s in the organization. See Team management and Roles & permissions.

Connect your systems

Create an API key in the workspace your systems call, under Settings → Workspace → API keys, and send it as a bearer token on every request. The dashboard shows a new key only once, so store it in your secret manager right away. See API keys and Live predictions.

Work with models and batches

Open Models to see each model’s versions and schema, reassign an alias such as production, and run a prediction from a version’s ⋯ menu. Under Batches, score a whole file of records and download the results. See Model versioning and Batch inference.

Send and receive files

Upload files for Avra under File Transfer → Sent to Avra, and download what Avra prepares for you under File Transfer → Received from Avra, once Avra enables File Transfer for your organization. See Preparing your data.

Monitor and get alerted

Check who changed keys, members, or settings under Observability → Audit, and follow every prediction under Observability → Usage. Choose how alerts reach you and your team under Alerts → Notifications, and send events to your systems under Alerts → Webhooks. See Audit and usage logs, Notifications, and Webhooks.

Manage workspaces and billing

Create a workspace from the workspace switcher, and edit or archive it under Settings → Workspace → General. Invoices open from Settings → Organization → Billing for Creators and Billing Managers. See Workspaces.

Where to go next

Was this page helpful?