Dashboard

The CyteType Dashboard is a web interface for managing API tokens and annotation reports. Navigate to /dashboard on your CyteType server.

Workspaces

The dashboard supports two workspaces, selectable from the switcher at the top of the sidebar.

Personal — Your free individual account. Tokens and reports here are private by default and subject to the free-tier daily limit (three annotation runs per day).

Organization — Available if your account is linked to an organization license. Switching to this workspace shows tokens and reports scoped to your organization, with shared quota, org-wide visibility options, and team administration features.

API Tokens

API tokens authenticate your requests to the CyteType API. Open the API Tokens section from the sidebar navigation.

Steps

1. Click Create New Token.
2. Enter a descriptive name for the token (e.g. Production Server or Local notebook).
3. Optionally set a Quota Limit, the maximum number of clusters this token is allowed to annotate. Leave empty for no limit.
4. Click Create Token.

The token value is displayed in the table immediately. Copy it and store it securely; it is used as the auth_token parameter in the Python and R clients:

annotator = CyteType(adata, group_key="leiden", auth_token="your-token-here")

result <- CyteTypeR(
  obj = seurat_obj,
  prepped_data = prepped_data,
  study_context = "...",
  auth_token = "your-token-here"
)

Managing existing tokens

The token table shows each token's status, total jobs run, clusters annotated, quota, and creation date.

• To disable a token permanently, click Disable. Disabled tokens cannot be re-enabled.
• To copy a token value, click the copy button beside it.
• To rename a token or update its quota, click the edit icon next to the name or quota field.

Use the Sort dropdown to order tokens by date created, name, usage, quota, or status. The filter pills toggle between showing only active tokens and all tokens including disabled ones.

💡 Note: In the organization workspace, admins see all tokens created across the organization. Admins can create tokens on behalf of other members by entering a member's email address in the User Email field when creating a token. Members who are not admins cannot create tokens in the organization workspace.

Reports

The Reports section lists annotation jobs submitted under your account. Two tabs are available:

• Reports shared with me — Jobs from other organization members made visible to you (organization workspace only).
• My Reports — Jobs you own.

Controlling visibility

Each report has a visibility setting. Click the edit icon in the Visibility column to change it.

Sharing a report with specific users

Organization workspace only.

1. Select one or more reports using their checkboxes.
2. Click Share in the action bar.
3. Enter each person's email address and click Add.
4. Click Save Changes.

You can also click the value in the Shared With column of a single report to open the share dialog for that report directly.

When sharing multiple reports at once, new users are added to each report's existing share list without removing anyone already shared. When editing a single report's shares, the list is replaced entirely; remove users by deleting them from the list before saving.

Archiving reports

Archiving hides reports from the default view without deleting them. To archive one or more reports, select them and click Archive. To view archived reports, enable Show archived above the table. Select an archived report and click Unarchive to restore it.

Transferring ownership

Organization workspace only.

1. Select the reports.
2. Click Transfer in the action bar.
3. Enter the new owner's email address.
4. Click Transfer All.

❗️ Important: Transfer is permanent. The receiving user must be a member of the same organization.

Learn more

Python client

R client