> For the complete documentation index, see [llms.txt](https://docs.clickai.vn/clickai-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.clickai.vn/clickai-docs/clickai-docs-en/developer/workspace.md).

# Workspace

<figure><img src="/files/TPkdlwDcP4ySj6Wz4Row" alt=""><figcaption></figcaption></figure>

## Table of Contents

·       \[Overview]\(#overview)

·       \[Workspace Model]\(#workspace-model)

·       \[Creating a Workspace]\(#creating-a-workspace)

·       \[Model Providers]\(#model-providers)

·       \[Plugins]\(#plugins)

·       \[Tools]\(#tools)

·       \[App Management]\(#app-management)

·       \[Member Management]\(#member-management)

·       \[Personal Settings]\(#personal-settings)

&#x20;

## Overview

A Workspace is the central control hub for all activities on ClickAI. All resources — applications, knowledge bases, model configs, team members — are organized within a workspace.

<figure><img src="/files/enfWMyMqi0Yn4TlmNvHo" alt=""><figcaption></figcaption></figure>

## Workspace Model

🏢 Your Organization\
└── 📁 Workspace\
&#x20;   ├── 🤖 Apps (chatbots, workflows, agents)\
&#x20;   ├── 📊 Knowledge Bases (documents, embeddings)\
&#x20;   ├── 👥 Team Members (roles & permissions)\
&#x20;   ├── 🧠 Model Providers (API keys, configurations)\
&#x20;   ├── 🔧 Tools & Plugins (integrations, custom code)\
&#x20;   └── 💳 Billing (subscription, limits, usage)

### How Resources Connect

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Role</td><td valign="top">Permissions</td></tr><tr><td valign="top">Owner</td><td valign="top">Manage billing, model providers, workspace settings</td></tr><tr><td valign="top">Admin</td><td valign="top">Manage team members, configure models/plugins</td></tr><tr><td valign="top">Editor</td><td valign="top">Build applications, manage knowledge bases</td></tr><tr><td valign="top">Member</td><td valign="top">Use published applications</td></tr></tbody></table>

&#x20;

&#x20;

## Creating a Workspace

1\.     Log in to ClickAI at <https://app.clickai.vn>

2\.     Click the workspace selector in the header

3\.     Select "+ Create Workspace"

4\.     Name and describe the workspace

5\.     Invite team members (optional)

📝 NOTE: Each account can create or join multiple workspaces. Data between workspaces is completely independent.

&#x20;

## Model Providers

Configure AI model providers — the foundation powering all your applications.

### Supported Providers

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Provider</td><td valign="top">Key Models</td><td valign="top">Type</td></tr><tr><td valign="top">OpenAI</td><td valign="top">GPT-4o, GPT-4o-mini, o1, o3</td><td valign="top">LLM, Embedding</td></tr><tr><td valign="top">Anthropic</td><td valign="top">Claude 4 Opus, Sonnet, Haiku</td><td valign="top">LLM</td></tr><tr><td valign="top">Google</td><td valign="top">Gemini 2.5 Pro, Flash</td><td valign="top">LLM</td></tr><tr><td valign="top">Azure OpenAI</td><td valign="top">All GPT models</td><td valign="top">LLM, Embedding</td></tr><tr><td valign="top">DeepSeek</td><td valign="top">DeepSeek-V3, R1</td><td valign="top">LLM</td></tr><tr><td valign="top">Groq</td><td valign="top">Llama 3, Mixtral</td><td valign="top">LLM</td></tr><tr><td valign="top">Cohere</td><td valign="top">Command R+, Embed</td><td valign="top">LLM, Rerank</td></tr><tr><td valign="top">Jina AI</td><td valign="top">Jina Embeddings</td><td valign="top">Embedding</td></tr></tbody></table>

&#x20;

### Configuring a Model Provider

6\.     Go to Settings → Model Providers

7\.     Select the provider you want to connect

8\.     Enter the provider's API Key

9\.     Test connection → Save

⚠️ IMPORTANT: Model provider API Keys are encrypted and securely stored. Only Owner and Admin can view and edit API Keys.

### Model Types

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Type</td><td valign="top">Function</td><td valign="top">Used In</td></tr><tr><td valign="top">LLM</td><td valign="top">Text generation, reasoning</td><td valign="top">LLM node in Workflow</td></tr><tr><td valign="top">Text Embedding</td><td valign="top">Convert text → vectors</td><td valign="top">Knowledge Base indexing</td></tr><tr><td valign="top">Rerank</td><td valign="top">Re-sort search results</td><td valign="top">Knowledge Retrieval</td></tr><tr><td valign="top">Speech-to-Text</td><td valign="top">Convert voice → text</td><td valign="top">App Toolkit STT</td></tr><tr><td valign="top">Text-to-Speech</td><td valign="top">Convert text → voice</td><td valign="top">App Toolkit TTS</td></tr><tr><td valign="top">Moderation</td><td valign="top">Content moderation</td><td valign="top">Content Moderation</td></tr></tbody></table>

&#x20;

&#x20;

## Plugins

Extend ClickAI capabilities through the plugin system.

### Plugin Marketplace

Browse and install plugins from the marketplace:

10\.  Go to Plugins from the sidebar

11\.  Browse the Marketplace or search

12\.  Click "Install" on the desired plugin

13\.  Configure credentials if required

### Plugin Types

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Type</td><td valign="top">Description</td><td valign="top">Example</td></tr><tr><td valign="top">Tool</td><td valign="top">Add tools for Agent/Workflow</td><td valign="top">Google Search, Weather API</td></tr><tr><td valign="top">Model</td><td valign="top">Add model providers</td><td valign="top">Custom LLM endpoint</td></tr><tr><td valign="top">Extension</td><td valign="top">Extend platform features</td><td valign="top">Content moderation API</td></tr><tr><td valign="top">Bundle</td><td valign="top">Multi-type combination pack</td><td valign="top">Full integration suite</td></tr></tbody></table>

&#x20;

&#x20;

## Tools

Manage tools that Agents and Workflows can use.

### Built-in Tools

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Tool</td><td valign="top">Function</td></tr><tr><td valign="top">Web Search</td><td valign="top">Search for information online</td></tr><tr><td valign="top">Wikipedia</td><td valign="top">Look up Wikipedia articles</td></tr><tr><td valign="top">Calculator</td><td valign="top">Mathematical calculations</td></tr><tr><td valign="top">Current Time</td><td valign="top">Get current time</td></tr><tr><td valign="top">Weather</td><td valign="top">Check weather conditions</td></tr></tbody></table>

&#x20;

### Custom Tools (API-based)

Connect external APIs as tools for AI to use:

14\.  Go to Tools → "+ Create Custom Tool"

15\.  Enter the API's OpenAPI/Swagger specification

16\.  Configure authentication

17\.  Test tool → Save

18\.  The tool will appear in the tools list when building Apps

\# Example OpenAPI Spec for Custom Tool\
openapi: 3.0.0\
info:\
&#x20; title: CRM Lookup\
&#x20; version: 1.0.0\
paths:\
&#x20; /api/customers/{id}:\
&#x20;   get:\
&#x20;     summary: Look up customer information\
&#x20;     parameters:\
&#x20;       \- name: id\
&#x20;         in: path\
&#x20;         required: true\
&#x20;         schema:\
&#x20;           type: string

&#x20;

## App Management

### Application List

The Apps page displays all applications in the workspace as grid cards:

·       App name & icon — Application name and icon

·       App type — Chatbot, Workflow, Agent

·       Status — Active, Draft, Paused

·       Last updated — Most recent update time

·       Team members — Who is working on the app

### Management Actions

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Action</td><td valign="top">Description</td></tr><tr><td valign="top">Create</td><td valign="top">Create a new application</td></tr><tr><td valign="top">Duplicate</td><td valign="top">Clone an application</td></tr><tr><td valign="top">Export</td><td valign="top">Export DSL (YAML) for backup or sharing</td></tr><tr><td valign="top">Import</td><td valign="top">Import application from DSL file</td></tr><tr><td valign="top">Delete</td><td valign="top">Delete application (cannot be undone)</td></tr><tr><td valign="top">Tag</td><td valign="top">Assign classification tags</td></tr></tbody></table>

&#x20;

&#x20;

## Member Management

### Inviting Members

19\.  Go to Settings → Members

20\.  Click "+ Invite"

21\.  Enter email → Select role → Send invitation

### Permission System

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th><th valign="top"></th><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top">Permission</td><td valign="top">Owner</td><td valign="top">Admin</td><td valign="top">Editor</td><td valign="top">Member</td></tr><tr><td valign="top">Manage billing</td><td valign="top">✅</td><td valign="top">❌</td><td valign="top">❌</td><td valign="top">❌</td></tr><tr><td valign="top">Configure model providers</td><td valign="top">✅</td><td valign="top">✅</td><td valign="top">❌</td><td valign="top">❌</td></tr><tr><td valign="top">Manage team members</td><td valign="top">✅</td><td valign="top">✅</td><td valign="top">❌</td><td valign="top">❌</td></tr><tr><td valign="top">Install plugins</td><td valign="top">✅</td><td valign="top">✅</td><td valign="top">❌</td><td valign="top">❌</td></tr><tr><td valign="top">Build &#x26; edit apps</td><td valign="top">✅</td><td valign="top">✅</td><td valign="top">✅</td><td valign="top">❌</td></tr><tr><td valign="top">Manage knowledge</td><td valign="top">✅</td><td valign="top">✅</td><td valign="top">✅</td><td valign="top">❌</td></tr><tr><td valign="top">View logs &#x26; analytics</td><td valign="top">✅</td><td valign="top">✅</td><td valign="top">✅</td><td valign="top">❌</td></tr><tr><td valign="top">Use applications</td><td valign="top">✅</td><td valign="top">✅</td><td valign="top">✅</td><td valign="top">✅</td></tr></tbody></table>

&#x20;

🚨 WARNING: Only the \*\*Owner\*\* can transfer ownership or delete the workspace. Consider carefully before changing the owner.

&#x20;

## Personal Settings

### Account Information

Manage your personal profile:

·       Display name — Name shown in workspace

·       Email — Login email (cannot be changed)

·       Avatar — Profile picture

·       Password — Change password

·       Language — Interface language (Vietnamese, English, ...)

### Personal API Keys

Manage API keys for your account:

22\.  Go to Personal Settings → API Keys

23\.  Click "+ Create API Key"

24\.  Set a descriptive name → Copy key

25\.  Use this key for CLI or API management

### Integrations

Connect your account with external services:

·       GitHub — Import code, sync repositories

·       Google — OAuth login, Google Drive access

·       SSO — Single Sign-On via SAML/OIDC

&#x20;

*📖 Previous: \[Knowledge]\(./04-knowledge-en.md) · \[Back to: Build]*


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.clickai.vn/clickai-docs/clickai-docs-en/developer/workspace.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
