> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open.cx/llms.txt
> Use this file to discover all available pages before exploring further.

# Companion introduction

> Companion is the assistant inside your OpenCX dashboard. Learn what it can do for you, how its changes are reviewed, and who can use it.

Companion is the assistant built into the OpenCX dashboard. Ask it in plain language to train your AI agent, investigate a session, answer an analytics question, or build a workflow, sequence or mini app, and it does the work with your workspace's real data.

> [!NOTE]
>
> Companion is not the same as **Companion mode** of the website widget, which puts an assistant on your own website for your visitors. See [Companion mode](https://docs.open.cx/widget/companion-mode.md).

> [!NOTE]
>
> **Companion** in the sidebar of your [OpenCX dashboard](https://platform.open.cx/companion). Chatting requires the **Companion** Write permission; see [Who can use Companion](#who-can-use-companion).

## Open Companion

* **Full page:** select **Companion** at the bottom of the sidebar. The chat sits in the middle, your history on the left, and [workspace tabs](https://docs.open.cx/companion/workspace-tabs.md) on the right.
* **From any other page:** select the **Ask Companion…** bar at the bottom of the screen, or press Option+Space (Alt+Space on Windows) to open or close it. Use **Expand**, then **Open full page**, to move the chat to the Companion page.
* **From ⌘K:** type a request and press Tab to hand it to Companion in a new chat.
* **From an item:** some editors link straight to it, such as **Edit with Companion** on a [phone agent's instructions](https://docs.open.cx/phone/agent-config.md).

Users whose role defaults to the Phone Desk workspace don't see the sidebar item. If your workspace uses a partner's branding, the item is named after the partner's app; see [Usage and limits](https://docs.open.cx/companion/usage-and-limits.md#companion-under-a-partner-brand).

## What Companion can help with

| Job | Examples |
| - | - |
| Set up and train your AI agent | Write instructions and the AI Profile, add your website as a knowledge source, create and run actions. New organizations can follow the [setup guide](https://docs.open.cx/companion/setup-guide.md). |
| Investigate sessions | Paste an inbox session link, or open Companion on a session, and ask why the AI answered or handed off the way it did. |
| Analyze reports | Automation rate, handoffs, CSAT, SLA, agent and team performance, capacity and time worked, including breakdowns the standard reports don't offer. Answers can include charts. |
| Build automations | Create, edit, test and activate workflows; run an action or workflow once. |
| Reach customers | Build an outbound sequence: audience, messages and sender. |
| Build mini apps | Dashboards and inbox widgets that live in your dashboard. |
| Edit customer-facing content | Rewrite or translate help center articles. |
| Phone agents | Create or edit a phone agent and test it from your browser. |
| Other settings | Macros, CSAT templates, teams, routing skills, tags and more. |
| Get help | Answer questions about OpenCX features, and notify the OpenCX team when it can't help. |

Companion can't change the website widget's settings. It tells you what to set and links you to the widget settings page.

## How changes are reviewed

Companion saves work in its safest form and leaves going live to you. Each change appears as a card in the chat; select it to open the item in a [workspace tab](https://docs.open.cx/companion/workspace-tabs.md).

| What Companion changes | What it saves | How it goes live |
| - | - | - |
| New instruction | A draft (**Created as draft**) | Publish it in the editor, or ask Companion to |
| Existing instruction | Suggested changes marked in the draft (**N changes suggested**). Customers keep getting the published version. | Accept or reject each change, then publish. Publishing stays disabled until every suggestion is decided. |
| AI Profile | A draft with suggested changes (**AI Profile Draft**) | Companion publishes only when you ask, after showing you the draft. The setup guide's Discover & Train step is the exception: it publishes so you can test the agent. |
| Help center article | Suggestions in the article's draft | Keep or undo each one, then publish. See [Help center articles](https://docs.open.cx/help-center/articles.md). |
| Workflow | A new workflow is saved inactive. Editing an active workflow saves a new inactive version, and the live version keeps running. | Companion asks before activating. |
| Phone agent | Changes land in the agent's draft | Published when you ask |
| Sequence | A draft sequence | Companion stops and asks before launch |
| Running an action or workflow | A real request | Companion asks you to confirm first |

Other changes you ask for, such as a team setting, apply right away. Every change is recorded in the [audit log](https://docs.open.cx/security/audit-logs.md) with Companion as the actor. Ask Companion to revert one: it finds the earlier value in the log and confirms with you before restoring it.

## Plans and clarifying questions

For a task with several steps, Companion shows a plan and waits for your go-ahead before it changes anything. While it works, a bar above the composer shows the current step and a count such as **3/8**; select it to see the whole list.

When it needs details, Companion asks them one at a time in place of the composer. Pick an option or select **I'll type it**, then move with **Back** and **Next** and finish with **Send**.

## Give Companion context

* **The page you're on:** opened on a session, an instruction, the AI Profile, a workflow, a phone agent or a help center article, Companion attaches it as a chip above the composer and works on that item.
* **Session links:** paste an inbox session link into the composer to attach that session. Remove a pasted chip with its ✕.
* **Mentions:** type @ or select **+** to mention a teammate, team, action, workflow, knowledge base entry or instruction.
* **Files:** select the paperclip, drag a file onto the composer, or paste it. Spreadsheets, images, PDFs and text files work, up to 10 files per message and 25 MB each. Type what to do with the file as well: a message needs text to send.
* **Voice:** select the microphone to dictate.

Companion keeps working if you close the panel or leave the page. Open the chat again to follow along, or select stop to end the reply. Use **Good response** or **Bad response** under a reply to send feedback to the team.

## Chat history

Your chats are private to you. On the Companion page, select **Show history** to list your 50 most recent chats, grouped by **Today**, **Yesterday**, **This week** and **Older**, with **Search chats** at the top. Each chat is named after your first message.

* **Rename chat** changes its name.
* **Delete chat** permanently deletes the chat and its messages. Changes Companion made in that chat stay.

## Who can use Companion

Set these in [**Settings → Roles**](https://platform.open.cx/settings/roles). Companion always acts as the member using it, so it can't see or change anything their other permissions don't allow. Ask for something outside them and Companion tells you which permission you need.

| Permission | What it allows |
| - | - |
| **Companion** Read | Open past chats. No composer and no **Ask Companion…** bar. |
| **Companion** Write | Start chats, send messages and attach files. |
| **Mini apps** Read | Open the Companion page to view and run apps, without chatting. |
| **Mini apps** Write | Build mini apps with Companion, and edit them where the app's [editor list](https://docs.open.cx/build-agents/mini-apps.md) allows. |

## Troubleshooting

| Symptom | Likely cause | Fix |
| - | - | - |
| No composer, and the landing says **You don't have permission to start new chats.** | Your role lacks **Companion** Write | Ask an admin to grant it in **Settings → Roles**. |
| **No reply came back. Try sending your message again.** | The message didn't get a reply | Send it again. |
| **Companion is paused until …** | Your organization reached the Companion limit it set for the month | See [Usage and limits](https://docs.open.cx/companion/usage-and-limits.md). |
| None of the above | | Select **Bad response** on the reply, or contact support. |

***

## Related Documentation

> [card] [Workspace tabs](https://docs.open.cx/companion/workspace-tabs.md)
>
> Review drafts, apps and tests beside the chat.

> [card] [Setup guide](https://docs.open.cx/companion/setup-guide.md)
>
> Guided path for a new organization.

> [card] [Usage and limits](https://docs.open.cx/companion/usage-and-limits.md)
>
> Monthly usage, notices and pauses.

> [card] [Permissions reference](https://docs.open.cx/security/permissions-reference.md)
>
> Every role permission explained.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.