# Pharen

> Documentation for Pharen Hub — the AI workspace that unifies docs, lists, channels, mail, and agents so your team can automate workflows and move faster.

## Docs

- [Pharen UI component library](https://docs.pharen.app/ui/overview.md): Install Pharen UI and use the shared Vue 3 components in your applications.
- [Install Pharen UI](https://docs.pharen.app/ui/installation.md): Install @pharen/ui, load the shared styles, and render your first Vue component.
- [Styles and theming](https://docs.pharen.app/ui/theming.md): Customize Pharen UI with CSS variables and class-based dark mode.
- [Components](https://docs.pharen.app/ui/components/index.md): Browse every publicly exported component module from @pharen/ui.
- [AI Components](https://docs.pharen.app/ui/ai/index.md): Build AI messages, tool calls, thinking states, and conversation interfaces.
- [AI model select](https://docs.pharen.app/ui/components/ai-model-select.md): Import and use the AI model select components from @pharen/ui.
- [Autocomplete](https://docs.pharen.app/ui/components/autocomplete.md): Import and use the Autocomplete components from @pharen/ui.
- [Calendar](https://docs.pharen.app/ui/components/calendar.md): Import and use the Calendar components from @pharen/ui.
- [Checkbox](https://docs.pharen.app/ui/components/checkbox.md): Import and use the Checkbox components from @pharen/ui.
- [Color picker](https://docs.pharen.app/ui/components/color-picker.md): Import and use the Color picker components from @pharen/ui.
- [Combobox](https://docs.pharen.app/ui/components/combobox.md): Import and use the Combobox components from @pharen/ui.
- [Date picker](https://docs.pharen.app/ui/components/date-picker.md): Import and use the Date picker components from @pharen/ui.
- [Date selector](https://docs.pharen.app/ui/components/date-selector.md): Import and use the Date selector components from @pharen/ui.
- [Dropfile](https://docs.pharen.app/ui/components/dropfile.md): Import and use the Dropfile components from @pharen/ui.
- [Field](https://docs.pharen.app/ui/components/field.md): Import and use the Field components from @pharen/ui.
- [File upload](https://docs.pharen.app/ui/components/file-upload.md): Import and use the File upload components from @pharen/ui.
- [Form](https://docs.pharen.app/ui/components/form.md): Import and use the Form components from @pharen/ui.
- [Input](https://docs.pharen.app/ui/components/input.md): Import and use the Input components from @pharen/ui.
- [Input group](https://docs.pharen.app/ui/components/input-group.md): Import and use the Input group components from @pharen/ui.
- [Input OTP](https://docs.pharen.app/ui/components/input-otp.md): Import and use the Input OTP components from @pharen/ui.
- [Label](https://docs.pharen.app/ui/components/label.md): Import and use the Label components from @pharen/ui.
- [Multi select](https://docs.pharen.app/ui/components/multi-select.md): Import and use the Multi select components from @pharen/ui.
- [Native select](https://docs.pharen.app/ui/components/native-select.md): Import and use the Native select components from @pharen/ui.
- [Number field](https://docs.pharen.app/ui/components/number-field.md): Import and use the Number field components from @pharen/ui.
- [Phone input](https://docs.pharen.app/ui/components/phone-input.md): Import and use the Phone input components from @pharen/ui.
- [Pin input](https://docs.pharen.app/ui/components/pin-input.md): Import and use the Pin input components from @pharen/ui.
- [Radio group](https://docs.pharen.app/ui/components/radio-group.md): Import and use the Radio group components from @pharen/ui.
- [Rating](https://docs.pharen.app/ui/components/rating.md): Import and use the Rating components from @pharen/ui.
- [Remote select](https://docs.pharen.app/ui/components/remote-select.md): Import and use the Remote select components from @pharen/ui.
- [Search input](https://docs.pharen.app/ui/components/search-input.md): Import and use the Search input components from @pharen/ui.
- [Segmented control](https://docs.pharen.app/ui/components/segmented-control.md): Import and use the Segmented control components from @pharen/ui.
- [Select](https://docs.pharen.app/ui/components/select.md): Import and use the Select components from @pharen/ui.
- [Slider](https://docs.pharen.app/ui/components/slider.md): Import and use the Slider components from @pharen/ui.
- [Switch](https://docs.pharen.app/ui/components/switch.md): Import and use the Switch components from @pharen/ui.
- [Textarea](https://docs.pharen.app/ui/components/textarea.md): Import and use the Textarea components from @pharen/ui.
- [Toggle](https://docs.pharen.app/ui/components/toggle.md): Import and use the Toggle components from @pharen/ui.
- [Toggle group](https://docs.pharen.app/ui/components/toggle-group.md): Import and use the Toggle group components from @pharen/ui.
- [Breadcrumb](https://docs.pharen.app/ui/components/breadcrumb.md): Import and use the Breadcrumb components from @pharen/ui.
- [Button](https://docs.pharen.app/ui/components/button.md): Import and use the Button components from @pharen/ui.
- [Button group](https://docs.pharen.app/ui/components/button-group.md): Import and use the Button group components from @pharen/ui.
- [Detail icon nav](https://docs.pharen.app/ui/components/detail-icon-nav.md): Import and use the Detail icon nav components from @pharen/ui.
- [Menubar](https://docs.pharen.app/ui/components/menubar.md): Import and use the Menubar components from @pharen/ui.
- [Navigation menu](https://docs.pharen.app/ui/components/navigation-menu.md): Import and use the Navigation menu components from @pharen/ui.
- [Pagination](https://docs.pharen.app/ui/components/pagination.md): Import and use the Pagination components from @pharen/ui.
- [Scrollspy](https://docs.pharen.app/ui/components/scrollspy.md): Import and use the Scrollspy components from @pharen/ui.
- [Sidebar](https://docs.pharen.app/ui/components/sidebar.md): Import and use the Sidebar components from @pharen/ui.
- [Stepper](https://docs.pharen.app/ui/components/stepper.md): Import and use the Stepper components from @pharen/ui.
- [Tabs](https://docs.pharen.app/ui/components/tabs.md): Import and use the Tabs components from @pharen/ui.
- [Tree](https://docs.pharen.app/ui/components/tree.md): Import and use the Tree components from @pharen/ui.
- [Aspect ratio](https://docs.pharen.app/ui/components/aspect-ratio.md): Import and use the Aspect ratio components from @pharen/ui.
- [Avatar](https://docs.pharen.app/ui/components/avatar.md): Import and use the Avatar components from @pharen/ui.
- [Avatar group](https://docs.pharen.app/ui/components/avatar-group.md): Import and use the Avatar group components from @pharen/ui.
- [Badge](https://docs.pharen.app/ui/components/badge.md): Import and use the Badge components from @pharen/ui.
- [Border beam](https://docs.pharen.app/ui/components/border-beam.md): Import and use the Border beam components from @pharen/ui.
- [Card](https://docs.pharen.app/ui/components/card.md): Import and use the Card components from @pharen/ui.
- [Chart](https://docs.pharen.app/ui/components/chart.md): Import and use the Chart components from @pharen/ui.
- [Empty](https://docs.pharen.app/ui/components/empty.md): Import and use the Empty components from @pharen/ui.
- [Empty state](https://docs.pharen.app/ui/components/empty-state.md): Import and use the Empty state components from @pharen/ui.
- [Frame](https://docs.pharen.app/ui/components/frame.md): Import and use the Frame components from @pharen/ui.
- [Icon stack](https://docs.pharen.app/ui/components/icon-stack.md): Import and use the Icon stack components from @pharen/ui.
- [Icon tile](https://docs.pharen.app/ui/components/icon-tile.md): Import and use the Icon tile components from @pharen/ui.
- [Item](https://docs.pharen.app/ui/components/item.md): Import and use the Item components from @pharen/ui.
- [Kbd](https://docs.pharen.app/ui/components/kbd.md): Import and use the Kbd components from @pharen/ui.
- [Live waveform](https://docs.pharen.app/ui/components/live-waveform.md): Import and use the Live waveform components from @pharen/ui.
- [Plan](https://docs.pharen.app/ui/components/plan.md): Import and use the Plan components from @pharen/ui.
- [Progress](https://docs.pharen.app/ui/components/progress.md): Import and use the Progress components from @pharen/ui.
- [Separator](https://docs.pharen.app/ui/components/separator.md): Import and use the Separator components from @pharen/ui.
- [Skeleton](https://docs.pharen.app/ui/components/skeleton.md): Import and use the Skeleton components from @pharen/ui.
- [Spinner](https://docs.pharen.app/ui/components/spinner.md): Import and use the Spinner components from @pharen/ui.
- [Stat card](https://docs.pharen.app/ui/components/stat-card.md): Import and use the Stat card components from @pharen/ui.
- [Table](https://docs.pharen.app/ui/components/table.md): Import and use the Table components from @pharen/ui.
- [Timeline](https://docs.pharen.app/ui/components/timeline.md): Import and use the Timeline components from @pharen/ui.
- [Carousel](https://docs.pharen.app/ui/components/carousel.md): Import and use the Carousel components from @pharen/ui.
- [Collapsible](https://docs.pharen.app/ui/components/collapsible.md): Import and use the Collapsible components from @pharen/ui.
- [Resizable](https://docs.pharen.app/ui/components/resizable.md): Import and use the Resizable components from @pharen/ui.
- [Scroll area](https://docs.pharen.app/ui/components/scroll-area.md): Import and use the Scroll area components from @pharen/ui.
- [Accordion](https://docs.pharen.app/ui/components/accordion.md): Import and use the Accordion components from @pharen/ui.
- [Alert](https://docs.pharen.app/ui/components/alert.md): Import and use the Alert components from @pharen/ui.
- [Alert dialog](https://docs.pharen.app/ui/components/alert-dialog.md): Import and use the Alert dialog components from @pharen/ui.
- [Command](https://docs.pharen.app/ui/components/command.md): Import and use the Command components from @pharen/ui.
- [Context menu](https://docs.pharen.app/ui/components/context-menu.md): Import and use the Context menu components from @pharen/ui.
- [Dialog](https://docs.pharen.app/ui/components/dialog.md): Import and use the Dialog components from @pharen/ui.
- [Drawer](https://docs.pharen.app/ui/components/drawer.md): Import and use the Drawer components from @pharen/ui.
- [Dropdown menu](https://docs.pharen.app/ui/components/dropdown-menu.md): Import and use the Dropdown menu components from @pharen/ui.
- [Hover card](https://docs.pharen.app/ui/components/hover-card.md): Import and use the Hover card components from @pharen/ui.
- [Popover](https://docs.pharen.app/ui/components/popover.md): Import and use the Popover components from @pharen/ui.
- [Sheet](https://docs.pharen.app/ui/components/sheet.md): Import and use the Sheet components from @pharen/ui.
- [Sonner](https://docs.pharen.app/ui/components/sonner.md): Import and use the Sonner components from @pharen/ui.
- [Tooltip](https://docs.pharen.app/ui/components/tooltip.md): Import and use the Tooltip components from @pharen/ui.
- [Data grid](https://docs.pharen.app/ui/components/data-grid.md): Import and use the Data grid components from @pharen/ui.
- [Event calendar](https://docs.pharen.app/ui/components/event-calendar.md): Import and use the Event calendar components from @pharen/ui.
- [Filters](https://docs.pharen.app/ui/components/filters.md): Import and use the Filters components from @pharen/ui.
- [Gantt](https://docs.pharen.app/ui/components/gantt.md): Import and use the Gantt components from @pharen/ui.
- [Kanban](https://docs.pharen.app/ui/components/kanban.md): Import and use the Kanban components from @pharen/ui.
- [Sortable](https://docs.pharen.app/ui/components/sortable.md): Import and use the Sortable components from @pharen/ui.
- [Approval](https://docs.pharen.app/ui/ai/approval.md): Import and use the Approval components from @pharen/ui/components/ai.
- [Chain of thought](https://docs.pharen.app/ui/ai/chain-of-thought.md): Import and use the Chain of thought components from @pharen/ui/components/ai.
- [Checkpoint](https://docs.pharen.app/ui/ai/checkpoint.md): Import and use the Checkpoint components from @pharen/ui/components/ai.
- [Code block](https://docs.pharen.app/ui/ai/code-block.md): Import and use the Code block components from @pharen/ui/components/ai.
- [Context](https://docs.pharen.app/ui/ai/context.md): Import and use the Context components from @pharen/ui/components/ai.
- [Conversation](https://docs.pharen.app/ui/ai/conversation.md): Import and use the Conversation components from @pharen/ui/components/ai.
- [Message](https://docs.pharen.app/ui/ai/message.md): Import and use the Message components from @pharen/ui/components/ai.
- [Pharen thinking](https://docs.pharen.app/ui/ai/pharen-thinking.md): Import and use the Pharen thinking components from @pharen/ui/components/ai.
- [Plan](https://docs.pharen.app/ui/ai/plan.md): Import and use the Plan components from @pharen/ui/components/ai.
- [Reasoning](https://docs.pharen.app/ui/ai/reasoning.md): Import and use the Reasoning components from @pharen/ui/components/ai.
- [Shimmer](https://docs.pharen.app/ui/ai/shimmer.md): Import and use the Shimmer components from @pharen/ui/components/ai.
- [Suggestion](https://docs.pharen.app/ui/ai/suggestion.md): Import and use the Suggestion components from @pharen/ui/components/ai.
- [Thinking label](https://docs.pharen.app/ui/ai/thinking-label.md): Import and use the Thinking label components from @pharen/ui/components/ai.
- [Tool](https://docs.pharen.app/ui/ai/tool.md): Import and use the Tool components from @pharen/ui/components/ai.
- [Pharen Hub Overview: Unified AI Workspace for Teams](https://docs.pharen.app/hub/overview.md): Pharen Hub brings together docs, lists, channels, mail, and AI agents in five coordinated layers. One workspace for your entire team.
- [Pharen Hub AI Agents: Chat, Agents, and App Builder](https://docs.pharen.app/hub/ai-agents.md): Build AI agents with custom skills, automate execution with handoffs, and create custom workflow apps — all inside the Pharen Hub AI layer.
- [Pharen Hub Workflows: Automate Approvals and Processes](https://docs.pharen.app/hub/workflows.md): Build approval workflows, automate triggers and notifications, and maintain a full audit trail for every process — all inside Pharen Hub Functions.
- [Pharen Hub Docs & Lists: Manage Knowledge and Data](https://docs.pharen.app/hub/docs-and-lists.md): Store, edit, and structure your team's knowledge with Hub Docs and Lists. Switch between list, Kanban, and calendar views in one unified Data layer.
- [Pharen Hub Channels & Mail: Team Communication Layer](https://docs.pharen.app/hub/channels-and-mail.md): Connect your team with Hub channels, threaded chat, video meetings, and mail integration. Keep communication and workflows in one shared context.
- [Pharen Hub Mobile App: Approvals and Updates on the Go](https://docs.pharen.app/hub/mobile-app.md): The Pharen Hub mobile app keeps your team's approvals, notifications, and decisions moving from any device — fully synced with the web workspace.
- [Pharen Hub documentation](https://docs.pharen.app/general/overview.md): Start here to understand Pharen Hub, the AI workspace that brings team work, knowledge, workflows, communication, and agents into one shared context.
- [Core concepts of Pharen Hub: workspaces, docs, and agents](https://docs.pharen.app/general/concepts.md): Understand the core building blocks of Pharen Hub: workspaces, docs, lists, channels, workflows, approvals, permissions, and AI agents in one shared space.
- [Local setup and contributing](https://docs.pharen.app/general/local-setup.md): Set up the Pharen monorepo locally, run quality checks, and contribute changes with the same guardrails used by agents and maintainers.
- [Pharen Hub on iOS and Android](https://docs.pharen.app/mobile/overview.md): See what the Pharen Hub mobile app offers, including offline access, push notifications, and on-the-go editing for lists, docs, and workflows.
- [Install the Pharen Hub mobile app](https://docs.pharen.app/mobile/installation.md): Download, install, and sign in to the Pharen Hub mobile app on iOS and Android, including device requirements and single sign-on setup.
- [Automate tasks with Pharen Hub workflows](https://docs.pharen.app/workflows/overview.md): Understand how Pharen Hub workflows chain triggers and actions to automate repetitive work across lists, docs, channels, mail, and AI agents.
- [Configure workflow triggers in Pharen Hub](https://docs.pharen.app/workflows/triggers.md): Set up event, schedule, and webhook triggers that start Pharen Hub workflows when records change, time passes, or external systems send data.
- [Build workflow actions step by step](https://docs.pharen.app/workflows/actions.md): Add and configure actions that update records, send messages, call APIs, or run AI agents as part of a Pharen Hub workflow automation.
- [Organize structured data with lists](https://docs.pharen.app/lists/overview.md): Discover how Pharen Hub lists store structured records, link to docs and channels, and feed workflows and AI agents with reliable team data.
- [Field types and validation for lists](https://docs.pharen.app/lists/fields.md): Reference for every Pharen Hub list field type, including text, number, date, select, relation, and formula fields, plus validation options.
- [Table, Kanban, and Calendar list views](https://docs.pharen.app/lists/views.md): Switch between table, Kanban, and calendar views in Pharen Hub lists, then filter, sort, and group records to fit each team's workflow.
- [Design custom apps with Pharen Studio](https://docs.pharen.app/studio/overview.md): Meet Pharen Studio, the low-code builder for designing custom apps, interfaces, and automations on top of your Pharen Hub workspace data.
- [Build your first app in Pharen Studio](https://docs.pharen.app/studio/getting-started.md): Step-by-step guide to creating your first Pharen Studio app, from picking a data source to publishing an interface for your team to use.
- [Clean and reshape data with Transformation](https://docs.pharen.app/transformation/overview.md): Use Pharen Hub Transformation to clean, enrich, and reshape data between lists, files, and external systems without writing custom scripts.
- [Build data pipelines step by step](https://docs.pharen.app/transformation/pipelines.md): Design Pharen Hub Transformation pipelines that pull source data, run steps to clean and join it, and write the results back into lists or files.
- [Introduction to Pharen Hub: AI Workspace for Teams](https://docs.pharen.app/introduction.md): Pharen Hub unifies docs, lists, channels, mail, and AI agents in one workspace. Eliminate tool-switching and automate your team's workflows.
- [Quickstart: Up and Running with Pharen Hub in Minutes](https://docs.pharen.app/quickstart.md): Create your Pharen Hub workspace, invite teammates, and send your first message or document in under five minutes. No credit card required.
- [Workspace Setup: Configure Your Pharen Hub Environment](https://docs.pharen.app/workspace-setup.md): Learn how to name your workspace, organize teams, configure your profile, and master workspace settings to match how your team actually works.
- [Configure Custom Roles and Permissions in Pharen Hub](https://docs.pharen.app/admin/roles-and-permissions.md): Configure custom roles, assign granular permissions per team and workspace area, and maintain an audit-ready access history in Pharen Hub.
- [Configure Budget Controls for AI Usage in Pharen Hub](https://docs.pharen.app/admin/budget-controls.md): Set spending limits, configure approval rules for AI usage, and monitor costs across teams and workspace areas before they become a problem.
- [Control AI Model Policies and Providers in Pharen Hub](https://docs.pharen.app/admin/ai-model-policies.md): Control which AI models and providers your workspace can use, enforce approved infrastructure across all teams, and prevent unauthorized model usage.
- [Enable and Enforce Two-Factor Authentication in Pharen Hub](https://docs.pharen.app/admin/two-factor-auth.md): Set up two-factor authentication for your workspace, enforce it across all members, and apply stronger sign-in policies for internal and external users.
- [Pharen Hub Plans: Free, Starter, Team, Pro, Enterprise](https://docs.pharen.app/billing/plans.md): Compare all Pharen Hub workspace plans from Free to Enterprise. Monthly pricing, workflow run limits, and member caps for every tier.
- [AI Credits in Pharen Hub: How They Work and How to Add Them](https://docs.pharen.app/billing/ai-credits.md): Learn how Pharen Hub AI credits are consumed, how to top up with prepaid balance or a monthly subscription, and what happens when credits run out.
- [Pharen Hub Billing FAQ: Plans, Credits, and Pricing Answers](https://docs.pharen.app/billing/faq.md): Answers to the most common billing questions about Pharen Hub — plan selection, AI credits, workflow runs, list limits, and pricing discounts.
- [Pharen Hub REST API reference: base URL and authentication](https://docs.pharen.app/api-reference/introduction.md): Get started with the Pharen Hub REST API: base URL, Bearer token authentication, scopes, rate limits, and the interactive Mintlify playground.
- [Pharen API Authentication: API Keys and Bearer Tokens](https://docs.pharen.app/api-reference/authentication.md): Authenticate every Pharen API request with a Bearer token API key or the X-API-Key header, including curl, Python, and Node.js code examples.
- [Manage Pharen Hub API keys: create, scope, and rotate](https://docs.pharen.app/api-reference/api-keys.md): Create, scope, store, rotate, and revoke Pharen Hub API keys for programmatic access from scripts, internal tools, and backend services.
- [List calendar events](https://docs.pharen.app/api-reference/calendar/list-events.md): Fetch calendar events for sync jobs, dashboards, and reporting tools. Requires the `calendar:read` scope.
- [Create calendar event](https://docs.pharen.app/api-reference/calendar/create-event.md): Create a local calendar event from scheduling automations or import jobs. Requires the `calendar:create` scope.
- [List saved lists](https://docs.pharen.app/api-reference/lists/list-lists.md): Fetch list metadata and saved list data available to the API key. Requires the `lists:read` scope.
- [List documents](https://docs.pharen.app/api-reference/docs/list-documents.md): Fetch document and collection metadata available to the API key. Requires the `docs:read` scope.
- [List workflows](https://docs.pharen.app/api-reference/workflows/list-workflows.md): Fetch workflow definitions available to the API key. Requires the `workflows:read` scope.
- [Run workflow](https://docs.pharen.app/api-reference/workflows/run-workflow.md): Execute a workflow with optional JSON input. Requires the `workflows:run` scope.
- [List agents](https://docs.pharen.app/api-reference/agents/list-agents.md): Fetch agents available to the API key. Requires the `agents:read` scope.
- [Chat with agent](https://docs.pharen.app/api-reference/agents/chat-agent.md): Send a message to an agent and receive a response. Requires the `agents:run` scope.

## OpenAPI Specs

- [openapi](https://docs.pharen.app/openapi.json)