> For the complete documentation index, see [llms.txt](https://docs.birdie.so/birdie-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.birdie.so/birdie-docs/helpdesk/plain/installation.md).

# Installation

### Install Birdie in Plain 

#### 1. Get your Plain API Key

* First, go into your Plain workspace Settings > Machine users & API Keys.
* Create a new Machine User dedicated to Birdie.
* Create an API Key for this user, and add 6 permissions:
  1. <mark style="color:$danger;">`chat:create`</mark>
  2. <mark style="color:$danger;">`customer:read`</mark>
  3. <mark style="color:$danger;">`thread:read`</mark>
  4. <mark style="color:$danger;">`thread:reply`</mark>
  5. <mark style="color:$danger;">`user:read`</mark>
  6. <mark style="color:$danger;">`workspace:read`</mark>
* Copy the API Key and store it somewhere safe - you’ll need it in the next step.

#### 2. Setup Birdie

Go to your [**Birdie workspace settings**](https://app.birdie.so/settings/helpdesk), open the **Helpdesk Integrations** section, find **the "Plain" integration**, and click **Enable**.

A window will open prompting you to paste the API Key you just created. Paste it into the **API Key** field and click the **Test** button.

<div align="left"><figure><img src="/files/JF8eQz4cjbeQdBKG7eZe" alt=""><figcaption></figcaption></figure></div>

The API Key and permissions will be tested. If valid, click on **Save**.

You're all set! You can now [add the Birdie Snippet](/birdie-docs/helpdesk/plain/flows/human-initiated-requests-via-snippet.md) to request recordings from your users.


---

# 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.birdie.so/birdie-docs/helpdesk/plain/installation.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.