Help & Guides

The Organization section is the administrative control tower for your workspace. It provides a centralized view of your team's structure, usage, and security settings. Whether you are managing a small research group or a large enterprise deployment, this is where you define the boundaries and rules that govern your collaborative environment.

From this dashboard, you can invite members and assign granular roles, monitor API usage across different projects, and manage billing and subscription details. It allows you to ensure that the right people have access to the right resources while maintaining strict oversight of your organization's data and costs.

Profile

This page allows you to manage your organization's core information. You can update your organization's name and view key metadata, such as the unique Organization ID, creation date, and when it was last updated.

Additionally, this section contains the "Danger Zone," where you can permanently delete the organization. This action is irreversible and will remove all associated data, including agents, knowledge collections, and user information.

Members & Roles

This is where you manage who has access to your organization and what they are allowed to do. Adding members may affect your subscription cost, depending on your plan. For details, please see our Billing & Pricing documentation. The section is divided into three tabs: Members, Service Accounts, and Pending Invitations.

• Members: This tab lists all the human users who are part of your organization. You can manage their roles or remove them from the workspace here.
• Service Accounts: This tab lists non-human accounts used for automated workflows and API access. Each service account has a specific role assigned to it, and its API keys will be limited to that role's permissions.
• Pending Invitations: This tab shows all the email invitations that have been sent out but have not yet been accepted or declined. You can resend or revoke invitations from this list.
• Inviting Members: Click the "Invite Member" button to send an invitation via email. You must assign a role to each new member, which determines their permissions within the organization.

Role Definitions

Roles are sets of permissions that control access to different features. The available roles are:

Note: The roles listed below are the defaults provided by the platform. Your organization's administrators can customize these permissions and create new roles to fit your specific needs.

API Keys

Generate and manage API keys to integrate Alkimi with other applications and build custom workflows. API usage is metered and will consume credits from your account. For detailed endpoint information, see the full API Documentation, and for pricing details, see our Billing & Pricing documentation. It's critical to treat API keys like passwords—do not expose them in client-side code or commit them to version control.

Key Types

There are two types of API keys you can create:

• Personal Key: This key is tied to your user account and inherits all of your permissions. It's useful for personal scripts or applications.
• Service Account Key: This creates a new, non-human user in your organization. You assign a specific role to it, and the key's permissions are limited to that role. This is the recommended approach for applications and automated workflows, as it allows you to grant limited, specific access.

Billing

The billing page is where you can manage your organization's subscription plan, view your payment history, and access past invoices. For a detailed breakdown of our pricing, plans, and credit system, please see our full Billing & Pricing documentation.