Help & Guides

Welcome to Alkimi! This documentation will guide you through the main features of our platform. Whether you're building a simple Q&A bot or a complex, multi-tool agent, you'll find the information you need to get started.

Key Concepts

• Agents: Customizable AI entities that can perform tasks, answer questions, and automate workflows.
• Knowledge: Collections of documents and data that you can provide to your agents, giving them a unique context and knowledge base.
• Snippets (or Chunks): When you upload a document, it is broken down into smaller, manageable pieces of text called snippets. The retrieval system searches these snippets to find the most relevant information for a user's query.
• Chats: The primary interface for interacting with your agents.

Your First Agent: A 5-Minute Tutorial

Let's create a simple agent that can answer questions about a specific topic.

1. Create a Knowledge Collection: Navigate to the "Knowledge" tab. Click "Create Collection" and give it a name, like "Project Research."
2. Add a Document: Inside your new collection, click "Add Content" and choose to upload a PDF or text file related to your topic.
3. Create the Agent: Go to the "Agents" tab and click "Create Agent." Give it a name, like "Research Assistant."
4. Connect the Knowledge: In the agent configuration screen, go to the "Knowledge" tab. Select your "Project Research" collection to connect it to the agent.
5. Start Chatting: That's it! Go to the "Chat" tab, select your new "Research Assistant" from the sidebar, and start asking it questions about the document you uploaded.

Tip: Creating an Agent from a File
You can also create a new agent from a configuration file. In the "Create Agent" dialog, click the "Import from File" button in the footer. This will open a file picker for you to select a JSON configuration file. This is a great way to quickly set up a new agent from a backup or a shared template. You can override the name of the agent from the file by entering a new name in the dialog before clicking import.

Agents are the core of the Alkimi platform. You can create and customize agents to perform a wide variety of tasks. An agent's capabilities are defined by its configuration across several key areas.

Profile

This is where you define the agent's core identity and appearance. The profile page is divided into several sections:

• Settings: Give your agent a clear name and manage core chat features like showing reasoning or enabling message quoting.
• Branding: Customize the agent's appearance for integrations. You can select a primary theme color, and the interface provides a live preview of how the chat widget will look to end-users.
• Metadata: View read-only information about the agent, such as its unique ID, creation date, and last update time.
• Danger Zone: This section allows you to permanently delete the agent and all of its associated data. This action is irreversible.

Importing & Exporting Agents

The platform provides a powerful import and export feature, allowing you to back up, share, and template your agent configurations. This is handled through a simple JSON file format.

What is Exported?

When you export an agent, the following settings are included in the JSON file:

• Name
• Model Selection
• Instructions (the full prompt configuration)
• Tool settings (Web Search, URL Browsing)
• Branding settings

For security and portability, sensitive or environment-specific data is not included in the export. This includes:

• Knowledge base connections
• Permissions

How to Use

You can import and export agents in two places:

• On an Existing Agent: From the agent's Profile page, you will find "Import" and "Export" buttons in the header of the Settings card. Use "Export" to save the current configuration to a file, and "Import" to overwrite the current agent's settings with a configuration from a file. A confirmation dialog will appear to prevent accidental overwrites.
• When Creating a New Agent: In the Create Agent dialog, you can click the "Import from File" button in the footer. This allows you to create a new agent directly from a configuration file. If you enter a name in the "Agent Name" field in the dialog, it will override the name specified in the imported JSON file. If you leave it blank, the name from the file will be used.

Model

Here you select the underlying Large Language Model (LLM) that powers your agent. Models are categorized into tiers—Basic, Standard, and Premium—each with different strengths and credit costs. For more details, see our Billing & Pricing documentation.

• Basic Models: Highly efficient for straightforward tasks.
• Standard Models: Offer a strong balance of performance and cost for more advanced needs.
• Premium Models: Provide state-of-the-art intelligence for the most complex and demanding applications.

Context Budget

The context budget is a per-agent setting that controls the maximum credits available for each message. It determines both how much context your agent can access (conversation history, knowledge base content, and web results) and how it can generate its response (reasoning and final answer). Think of it as the "size" of each conversation turn.

How It Works

The context budget directly affects two key aspects of your agent's performance:

• Input Context Size: Higher budgets allow your agent to consider more conversation history, more content from your knowledge base, and more web search results when formulating its answer. This means better context awareness but higher cost per message.
• Output Generation: The budget also covers the cost of generating the agent's response, including its reasoning process and the final answer. More complex reasoning or longer responses will consume more of the budget.
• Intelligent Allocation: Our system automatically distributes your budget across different content sources (history, knowledge, URLs) based on relevance, ensuring the agent gets the most important information within your budget constraints.

Tier-Based Context Budgets

Each model tier has a minimum required context budget. This budget, set by the agent owner, acts as a maximum cost per message. The actual cost is variable based on usage (but never less than 1 credit). You must set a budget that meets the tier's minimum, and you can set it higher for more complex tasks.

• Basic Models: Require a minimum context budget of 4 credits per message.
• Standard Models: Require a minimum context budget of 12 credits per message.
• Premium Models: Require a minimum context budget of 40 credits per message.

Note: The agent configuration interface will show you the available budget options for your selected model.

Choosing the Right Budget

Consider these factors when setting your agent's context budget:

• Task Complexity: Simple queries (like "What is X?") can work with lower budgets, while complex analysis or multi-step reasoning benefits from higher budgets.
• Knowledge Base Size: If your agent needs to search through large knowledge collections, allocate more budget to ensure relevant snippets aren't truncated.
• Conversation Length: For ongoing conversations where context from previous messages is important, higher budgets help maintain continuity.
• Response Detail: If you need comprehensive, detailed answers with step-by-step reasoning, ensure the budget allows for longer outputs.
• Cost Management: Remember that every message consumes credits up to your set budget. For high-volume use cases, consider starting with a moderate budget and adjusting based on results.

You can adjust the context budget at any time from your agent's Model page. We recommend experimenting with different budgets to find the sweet spot for your specific use case. For detailed information on how context budget affects billing and credit consumption, see our Billing & Pricing documentation.

Instructions (Prompt Engineering)

The instructions are the set of instructions your agent follows. Effective prompt engineering is key to building a great agent. While you can write the entire prompt manually in the "Raw" editor, we recommend using the Context Studio, which provides a structured and intuitive way to build and manage your agent's instructions.

Note: Every new agent starts with a preloaded, general-purpose prompt, so it works out of the box. For more specific use cases, you can select from a library of templates (e.g., "Learning Assistant," "Customer Support Agent," or "HR Onboarding Assistant") or use the Context Studio for deeper customization.

The Context Studio

The Studio is designed to give you fine-grained control over your agent's behavior while providing a real-time preview of how your instructions will be formatted.

• Persona: This is the agent's core identity. A good persona is concise and sets the stage for all other instructions (e.g., "You are a helpful and witty customer support agent for a software company.").
• Tone of Voice: Select from a list of predefined tones to quickly shape your agent's personality and response style.
• Sections: These are the building blocks of your prompt. You can add, remove, and reorder sections to structure the agent's instructions. There are two types:
  • Freeform: A simple text area where you can write paragraphs of instructions.
  • Structured List: A hierarchical list editor that helps you organize complex rules or protocols into a clear, nested format.
• Add from Library: To speed up prompt creation, you can add pre-written, reusable sections from the library, covering common use cases like constraining the agent to its knowledge base or defining an escalation protocol.
• Variables: Use system variables (like {{agent_name}}) or define your own custom variables (like {{course_name}}) to make your prompts dynamic and reusable.
• Live Preview: As you build your prompt in the Studio, a live preview on the right shows you exactly what the final system prompt will look like, including how variables are resolved.

Best Practices for Prompting:

• Be Specific: Clearly define the agent's role, the task it should perform, and any constraints. Instead of "Summarize text," try "Summarize the following text into three bullet points, focusing on the key financial outcomes."
• Provide Examples: Use the structured prompt editor to give few-shot examples of desired input and output. This is one of the most effective ways to guide the model's behavior.
• Define the Persona: Tell the agent how to behave. For example: "You are a helpful assistant. Your tone should be friendly and professional."

Knowledge

Connect your agent to one or more knowledge collections. This grounds the agent in your specific data, enabling it to answer questions based on the documents you've provided. An agent can access multiple collections simultaneously. See Context Limit & Cost below for more details on how connected collections affect performance.

Context Limit & Cost

Each language model has a maximum "context window," which is the total amount of information it can consider at one time. The agent's Knowledge page displays a Context Limit bar that helps you visualize how much of the selected model's capacity is being used by the connected collections.

It's important to understand how this relates to your agent's Context Budget: the context window is the model's maximum capacity, while the context budget is how much of that capacity you're allocating per message (measured in credits). Even if your knowledge collections fit within the model's context window, the actual amount of knowledge used per message is controlled by your context budget and our intelligent allocation system.

The thresholds for Optimal, High, and Critical usage are not fixed; they are dynamically calculated based on the specific language model your agent is using. The calculation considers two key factors: the model's total context window size and its performance on industry-standard benchmarks that measure how well it can recall information from large amounts of text. This ensures the guidance is tailored to your model's capabilities.

Note: The context limit bar is an estimate based on the number of snippets (chunks of text) from your knowledge collections. It is not a direct measure of tokens. As a rough guide, 10 snippets are approximately equivalent to one standard A4 page of text.

• Optimal: The ideal range for reliable and fast responses.
• High: The model could potentially overlook some details.
• Critical: Increased risk of slow responses, hallucinations, or missing key data.

Exceeding the context limit will lead to poor performance, as the agent cannot consider all the information at once. Choosing a more focused Retrieval Strategy or using a model with a larger effective context window are effective ways to manage this.

Examples

The following examples show how the context limit is calculated for different types of models. The thresholds are based on the model's context window size and its performance on long-context recall benchmarks.

Tools

Extend your agent's capabilities beyond its core knowledge by enabling tools. Using these tools will consume credits from your account; for a detailed breakdown, please see our Billing & Pricing documentation.

Note: All tools are disabled by default and must be explicitly enabled for each agent.

• Web Search: Allows the agent to perform real-time web searches. This tool can be configured in three ways:
  • Implicit: The agent decides for itself when a web search is needed to answer a user's query.
  • Explicit: The agent will only perform a web search when the user explicitly invokes it using `@web` in their message.
  • Disabled: The agent cannot perform web searches.
• Web Browse: Enables the agent to "read" the content of a specific webpage you provide in a link.
• File Uploads: Allow your agent to receive and analyze files and images directly from users in the chat. When enabled from the agent's main settings page, users can upload documents, and the agent can read their content to answer questions or perform tasks. This feature is currently only supported on Gemini models. The maximum size and number of files that can be uploaded is determined by your agent's Context Budget. Supported formats include images (PNG, JPG, GIF, WEBP), documents (PDF, TXT, MD), and LaTeX files (.tex, .latex, etc.).

For detailed tips on how to get the most out of these tools, see the Using Tools section of the Chat documentation.

Rules

The Rules Engine is a powerful feature (currently under development) that allows you to define conditional rules to dynamically modify your agent's behavior. Based on triggers like user questions or specific conditions, you will be able to:

• Inject additional instructions on-the-fly.
• Include specific knowledge sources, overriding default search strategies.
• Force the use of a particular tool with custom instructions.

Permissions

Control who can interact with and manage your agent. Permissions are managed at both the organization level and the individual agent level. By default, all organization members have "User" access to new agents unless a different default is set.

For a deeper dive into our access control model, please see our Security Documentation.

• Default Access: You can set a default role that applies to all organization members who have not been granted explicit permissions. This can be set to "User" or "No Access".
• Explicit Permissions: You can grant specific members a role for this agent that overrides the organization default.

Agent Roles

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

Branding

From the agent's profile page, you can customize its appearance when it's integrated into other applications. You can select a primary theme color, and the interface provides a live preview of how the chat widget will look to end-users.

Danger Zone

Each agent has its own Danger Zone on its profile page. This section allows you to permanently delete the agent and all of its associated data. This action is irreversible.

Website Embed

The integrations page allows you to embed your agent as a chat widget on any website. This is perfect for customer support, website navigation, or lead generation. You have access to several settings to configure its behavior and appearance:

Setup & Appearance

• Embed Code: You can embed the agent using two methods: a simple <iframe> tag for direct embedding, or a <script> tag for a floating chat widget. Both methods are provided for you to copy and paste.
• Iframe Styling: When using the iframe method, you can customize its appearance by toggling a border, rounded corners, and a box shadow to match your site's design.
• Welcome Message: Customize the initial message the widget displays to visitors.

Performance

• Prefetching: For the fastest possible load time, you can enable aggressive prefetching, which starts loading the chat assets as soon as the page loads.

Interactive Tools

These tools create a dynamic, two-way interaction between your agent and the user on your website. When a user sends a message from your site, the agent can be given context about the page they are on and what they are looking at. In turn, when the agent responds, it can highlight elements on the page to guide the user's attention.

Note: These tools are only available when using the script-based widget embed. For security and privacy, these features are disabled by default and must be explicitly enabled in the agent's integration settings.

• Current Page Awareness: Allows the agent to see the webpage the user is currently on, providing valuable context for its responses.
• User View Mirroring: Lets the agent see what the user is interacting with, such as selected text. This helps the agent understand the user's focus without them having to explain.
• Interactive Highlighting: Grants the agent the ability to highlight elements on your webpage and scroll the user to them, making it an excellent tool for guiding users through your site.

Discord

This feature is currently under development. Soon, you'll be able to connect your agent to Discord, allowing it to interact with users in your servers.

Slack

This feature is currently under development. Soon, you'll be able to connect your agent to Slack, allowing it to interact with users in your workspace.

Teams

This feature is currently under development. Soon, you'll be able to connect your agent to Microsoft Teams, allowing it to interact with users in your organization.

The Knowledge section allows you to create and manage collections of documents that your agents can use to answer questions and perform tasks. This is how you provide your agents with a custom, private knowledge base.

Profile

Each Knowledge Collection has a profile page where you can manage its name and description. This page also shows you which agents currently have access to the collection, allowing you to track its usage across your organization.

Danger Zone

The profile page contains the "Danger Zone," where you can permanently delete the entire collection and all the files within it. This action cannot be undone.

Retrieval Strategy

A retrieval strategy determines how your agent sources information from its knowledge base. When you upload a document, it's broken down into smaller pieces of text called "snippets" or "chunks". When a user asks a question, a search is performed to find the most relevant snippets. The retrieval strategy you select is then applied to each of those matched snippets individually. For example, if you choose "Surrounding Snippets" and three snippets are matched, the agent will receive the neighboring context for all three.

Choosing the right strategy is key to balancing context relevance, response speed, and cost. It's important to remember that this is a strategy, not a guarantee. To prevent overloading the agent, the system may reduce the amount of included context if it exceeds the agent's available capacity.

The diagram below illustrates the basic flow, and the sections that follow explain each strategy in detail.

Permissions

Control who can use and manage this collection. Similar to agents, you can set a default access level for your organization and grant explicit, overriding permissions to specific members.

Collection Roles

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

Content Management

Content within a collection is organized in a hierarchical tree structure, similar to a file system. You can create folders to organize your knowledge sources.

It's important to note that the folder hierarchy has no bearing on agent responses. It is purely an organizational tool to help you manage permissions and activate or deactivate content in bulk.

Naming & Structure

To maintain a clean and functional structure, the following naming rules apply:

• Item names cannot contain a forward slash (/).
• Folder names cannot exceed 64 characters.
• The names for files, text, and website items cannot exceed 150 characters.

While the system supports nesting folders up to 32 levels deep, we recommend keeping your folder structure relatively shallow (2-3 levels deep) to ensure easy navigation and management.

Content Types

You can add content to your collections in several ways:

• File Upload: Upload documents directly. Supported formats include PDF, DOCX, TXT, MD, and LaTeX.
• Website URL: Provide a URL, and the system will ingest the content from that page.
• Plain Text: Copy and paste text directly into the system.

Activating & Deactivating Content

Each item in your collection, including folders, can be individually activated or deactivated. Deactivating an item temporarily removes it from the knowledge base available to agents without permanently deleting it. This is useful for temporarily excluding certain documents or entire folders from agent responses.

The Chat interface is where you interact with your agents. You can start new conversations, manage existing ones, and view the agent's responses. The sidebar on the left lists all agents you have access to, allowing you to switch between them easily.

Managing Conversations

The chat sidebar is designed to help you keep your conversations organized. It features a tabbed interface to filter your chats and a context menu for quick actions.

The Chat Tabs

• History: This is your main inbox for all non-archived chats. Favorited conversations are pinned to the top for easy access, followed by the rest of your chats sorted by recent activity.
• Favorites: This tab provides a focused view of only your favorited chats.
• Archived: To keep your History clean, you can move conversations here. Archived chats are kept for your records but are hidden from the main list.

Chat Actions

You can perform several actions on your conversations using the context menu, which you can open by right-clicking a chat or clicking the ellipsis icon () that appears on hover. You can also favorite a chat by clicking the message icon next to its title.

• Favoriting: Marking a chat as a favorite () pins it to the top of your History and adds it to the Favorites tab. You can only favorite chats that are not temporary or archived.
• Archiving: This action moves a chat to the Archived tab. Note that archiving a favorited chat will automatically remove its favorite status.
• Renaming & Deleting: Standard options to rename or delete a conversation are also available in the context menu.

Temporary Chats

For quick, one-off conversations that you don't need to save, you can create a temporary chat by clicking the dashed message icon () next to the "New Chat" button. These chats offer enhanced privacy as they are never saved to your history and are permanently deleted when you navigate away from the page. You will be warned before leaving a temporary chat.

Searching Chats

The platform provides powerful search tools to help you find information within your chats. When you open the search bar in the sidebar, you have two options:

• Search Scope: A toggle button () in the search bar allows you to switch between searching only chat titles (for quick navigation) or performing a full-text search across all message content within your conversations. By default, it searches both titles and messages.
• In-Chat Navigation: When you perform a search that includes message content, a search navigator appears at the bottom of the active chat window. This tool shows the number of matches and allows you to jump directly to each instance of the search term within that conversation.

Suggested Questions

To help guide the conversation, the agent can provide a list of suggested questions. These AI-generated prompts may appear at the start of a new chat or after an agent's response to help you explore the topic further. You can customize how these suggestions are displayed from your Account Preferences.

Sharing Conversations

You can share conversations with others via a secure, read-only link. This is useful for collaboration, getting feedback, or simply sharing an interesting interaction with an agent. When you share a conversation, you are creating a static snapshot of the chat up to a certain point. The shared link will not update with new messages.

How to Share

There are two ways to share a conversation:

• Share Entire Chat: Click the share icon () in the chat header.
• Share a Snapshot: To share a conversation only up to a specific point, hover over any message, open its context menu, and select "Share from here". This creates a link that includes that message and all previous messages.

Both methods will open the sharing dialog, which provides several options to control how your chat is shared.

Sharing Options

• Visibility: You can control who can view the shared link.
  • External: Anyone with the link can view the conversation.
  • Organization: Only logged-in members of your organization can view the conversation.
• PII Removal: The system automatically checks for personally identifiable information (PII). To protect your privacy, sensitive information found within the chat content is removed by default. Additionally, your name as the sharer is hidden on "External" shares but remains visible to colleagues on "Organization" shares.
• Custom Label: You can give your shared link an optional, memorable label to make it easier to identify later.

Managing Your Shared Links

You can manage all of your shared links from the My Shares page in your account settings. This page provides a centralized view of every share link you've created.

• View & Copy: See a list of your shares, including their custom names and the chats they belong to. You can easily copy the link to your clipboard.
• Delete: You can revoke access to a shared chat at any time by deleting its link. Once deleted, the link will no longer be accessible. You can also delete all of your shares at once.

What the Recipient Sees

When someone opens your shared link, they will see a clean, read-only version of the conversation. The page includes the chat title, the agent's name, and the date it was shared. If the share is an "Organization" type link and the viewer is logged in, your name will also be displayed as the person who shared it. A notice will be shown if PII was removed from the content.

Uploading Files & Images

If an agent has file uploads enabled, you can attach files and images to your messages. This allows the agent to analyze the content of your documents, answer questions about them, or use the information within them to perform tasks.

How to Upload

To upload a file, click the paperclip icon () in the chat input bar. This will open a file selector. You can upload multiple files at once. Supported file types include:

• Images: PNG, JPG, GIF, WEBP
• Documents: PDF
• Code Files: LaTeX files (.tex, .latex, .ltx, .sty, .cls) and other text-based formats.
• Text Files: TXT, MD

Once uploaded, files will appear as small badges above the text input area. You can remove a file before sending by clicking the 'x' on its badge.

Viewing and Managing Files

After a message is sent, its file attachments are displayed as compact badges. You can click on a badge to open a preview for images, PDFs, and text-based files. To see all files that have been uploaded in a conversation, click the "View Files" () button in the chat header. This opens a dialog listing every file, where you can view details and download or preview them again.

Understanding Upload Capacity

Each agent with file uploads enabled has a maximum upload capacity, which is determined by its Context Budget. This capacity is measured in "pages" (for documents and images). As you attach files, a progress bar below the chat input will show you how much of the available capacity you are using. This ensures that the total size of uploaded files does not exceed what the agent can process in a single message.

Using Tools

When you're chatting with an agent that has tools enabled, you can invoke them to bring external information into the conversation.

Tips for Effective Web Searching

The web search tool is powerful, but you can get even better results by providing clear instructions. The agent uses an AI model to generate search queries based on your message, so the more specific you are, the better the outcome.

1. Be Explicit with Multiple Queries: If you need to compare or gather information on multiple topics, guide the agent to perform separate searches. This yields more focused results than a single, broad query.
   Example: Instead of asking Compare Google's Gemini Pro with Anthropic's Claude Sonnet, a more effective prompt would be:
   Please perform web searches for the technical specifications of Google's Gemini Pro and Anthropic's Claude Sonnet, then summarize the key differences.
2. Guide the Source Priority: You can tell the agent what kind of sources to prioritize.
   • First-Party: To get information directly from the official source, include a phrase like prioritize official sources or prioritize first party sources in your request. Different models may respond better to one phrase over the other, so using either is a good way to guide the agent. The agent will attempt to select URLs from the main subject's website (e.g., openai.com for a query about ChatGPT).
     Example: What are the latest features in Next.js? Prioritize first-party sources.
   • Third-Party: Conversely, if you're looking for reviews or independent analysis, you can specify that.
     Example: Search for reviews of the new M4 MacBook Pro, prioritizing third-party tech blogs.
3. Specify Content and Site Types: You can be even more granular by requesting information from certain types of websites or content.
   Example: Find information on sustainable farming practices from .edu or .gov websites.
4. Exclude Unwanted Sites: If you find that results are consistently coming from a source you don't want, you can ask the agent to avoid it.
   Example: What are the best vegetarian recipes? Avoid results from pinterest.com.

Understanding Web Search Limits

To ensure performance and relevance, the web search tool operates within a set of technical limits. It's helpful to be aware of these as you use the feature.

• Search Queries per Message: The agent will generate a maximum of 5 distinct search queries based on a single message from you.
• Websites Visited per Message: From the search results, the agent will select and "visit" (read the content of) up to 3 websites per search query, with an overall maximum of 10 websites in total for a single message.
• Total Content Limit: The agent has a reading limit. It will stop processing content from web pages after it has collected a significant amount of text. This means that even if 10 URLs are selected, the agent may not read all of them if the first few pages contain a large amount of text. This mechanism prevents the agent from being overloaded with information that exceeds its context capacity.

Monitoring the Process: Understanding Statuses

When an agent uses a tool like Web Search, you'll see a series of status updates in the chat window. These are designed to give you real-time insight into the agent's actions.

• Searching: The agent is actively performing a web search for the given query.
• Searched: The agent has completed the web search for the query.
• Browsing: The agent is currently reading and processing the content of the linked URL.
• Browsed: The agent has finished reading the content of the linked URL.
• Skipped: The agent selected this URL to read but did not process it because the Total Content Limit was reached first.
• Failed: The agent was unable to read the content of the URL. This can happen for various reasons, such as the website being down, access being forbidden, or the page containing no readable text.

Each status includes a clickable link that allows you to view the relevant search results or webpage in a new tab, giving you the same context the agent is working with.

How the Agent Selects URLs to Read

After performing a search, the agent uses an AI model to analyze all the resulting links and selects only the most promising ones to read. You will only see status updates for the URLs the agent decides to browse. Links that are deemed irrelevant by the model are discarded and will not appear in the agent's action steps.

The Organization section is where administrators can manage workspace-level settings, members, billing, and API keys.

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.

The Account section is where you manage your personal user profile, security settings, and preferences. It's divided into three main areas: Profile, Preferences, and Support.

Profile

The profile page is where you manage your personal information and security settings.

Personal Information

Update your first and last name. Your email address is used as your primary identifier and cannot be changed. You can also view metadata about your account, such as your User ID, account creation date, and last login time.

Password Management

Manage your account password. If you originally signed up using a social provider (like Google or Microsoft), you can set a password here to enable signing in with your email and password as an alternative.

Authentication Providers

Connect or disconnect third-party accounts (e.g., Google, Microsoft, Apple) to enable single sign-on (SSO) for easier access to your account. For more details on our security practices, see the Authentication section of our security documentation.

Danger Zone

This section allows you to deactivate your account. Deactivation will disable your account and log you out of all sessions. For permanent account deletion, which includes the removal of all your personal data, you must contact support.

My Organizations

From the "My Organizations" page, you can manage all the workspaces you are a part of. This is where you can create new organizations, switch between them, or leave ones you no longer need access to.

• Create an Organization: Start a new workspace for a team or project.
• Switch Organizations: If you are a member of multiple organizations, you can select which one is currently active.
• Leave an Organization: You can remove yourself from an organization at any time.
• Manage Invitations: View and respond to any pending invitations to join new organizations.

My Shares

The My Shares page provides a centralized place to view and manage all the conversation links you have shared. Here you can see a list of all your active share links, copy them to your clipboard, or revoke access by deleting them. For more details on how sharing works, see the Sharing Conversations section.

Preferences

The Preferences page allows you to customize your chat experience.

Suggestion Display

This setting controls the layout of chat suggestions on desktop views. For more information on what these are, see the Suggested Questions section. You can choose from several options:

Support

If you need help or have a question, you can contact our support team directly through the app. The support page contains a form where you can submit a request. Your name and email address are pre-filled, so you just need to provide a subject and a detailed message describing your issue.