> ## Documentation Index
> Fetch the complete documentation index at: https://daily-docs-pr-5482.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Pipecat Cloud Personal Access Tokens

> Authenticate CI/CD pipelines and automation against Pipecat Cloud with non-interactive personal access tokens (PATs).

Personal Access Tokens (PATs) let you authenticate with Pipecat Cloud without an interactive browser login. They're designed for headless environments like CI/CD pipelines, Docker containers, and automation scripts.

## When to use PATs

| Scenario                  | Recommended auth                     |
| ------------------------- | ------------------------------------ |
| Local development         | OAuth via `pipecat cloud auth login` |
| CI/CD pipelines           | PAT via `PIPECAT_TOKEN` env var      |
| Docker / remote servers   | PAT via `PIPECAT_TOKEN` or `use-pat` |
| Shared automation scripts | PAT via `PIPECAT_TOKEN` env var      |

<Note>
  PATs are different from **API keys**. API keys authenticate REST API requests
  to start agent sessions or manage resources. PATs authenticate *you* (or a
  service account) to the **CLI** — they are not intended for direct API calls.
</Note>

## Creating a PAT

Generate a PAT from the [Pipecat Cloud dashboard](https://pipecat.daily.co/account/tokens):

<Steps>
  <Step title="Open account settings">
    Navigate to **Account Settings → [Personal Access
    Tokens](https://pipecat.daily.co/account/tokens)** in the dashboard.
  </Step>

  <Step title="Create a new token">
    Click **Create Token**, give it a descriptive name (e.g.
    `github-actions-deploy`), and copy the token value. PATs start with
    `pcc_pat_`.
  </Step>

  <Step title="Store it securely">
    Save the token in your CI/CD platform's secret store (e.g. GitHub Actions
    secrets, GitLab CI variables). You won't be able to view the token again
    after leaving the page.
  </Step>
</Steps>

## Using a PAT

### Environment variable (recommended)

Set `PIPECAT_TOKEN` before running any CLI command. The CLI will authenticate using the token and automatically resolve your default organization.

```shell theme={null}
export PIPECAT_TOKEN="pcc_pat_..."
pipecat cloud auth whoami
pipecat cloud agent list
```

You can also set it inline for a single command:

```shell theme={null}
PIPECAT_TOKEN="pcc_pat_..." pipecat cloud deploy my-agent
```

To target a specific organization, set `PIPECAT_ORG` as well:

```shell theme={null}
export PIPECAT_TOKEN="pcc_pat_..."
export PIPECAT_ORG="my-team-org"
pipecat cloud agent list
```

### Storing a PAT locally

If you prefer not to set an environment variable each time, you can store a PAT in your local config file:

```shell theme={null}
pipecat cloud auth use-pat
```

The command prompts for the token rather than taking it as an argument, so it stays out of your shell history.

This validates the token against the API and writes it to `~/.config/pipecatcloud/pipecatcloud.toml`. All subsequent commands will use it automatically, just like after `auth login`.

## CI/CD examples

### GitHub Actions

Add your PAT as a repository secret named `PIPECAT_TOKEN`, then reference it in your workflow:

```yml theme={null}
jobs:
  deploy:
    runs-on: ubuntu-latest
    env:
      PIPECAT_TOKEN: ${{ secrets.PIPECAT_TOKEN }}
    steps:
      - uses: actions/checkout@v4

      - name: Install uv
        uses: astral-sh/setup-uv@v5

      - name: Install CLI
        run: uv tool install "pipecat-ai[cli]" --with pipecatcloud

      - name: Deploy
        run: pipecat cloud deploy my-agent --yes
```

<Tip>
  For deployments specifically, the [Deploy to Pipecat Cloud GitHub
  Action](./ci-with-github-actions) uses an API key instead. PATs are useful
  when you need to run arbitrary CLI commands in CI (e.g. managing secrets,
  listing agents, or scripting multi-step workflows). For scripting, see [Output
  modes and exit codes](/api-reference/cli/cloud/output) — `--output json` gives
  you parseable output on stdout, and each command has a flag that skips its
  prompt.
</Tip>

### GitLab CI

Add `PIPECAT_TOKEN` as a CI/CD variable (Settings → CI/CD → Variables, masked):

```yml theme={null}
deploy:
  image: python:3.12
  script:
    - curl -LsSf https://astral.sh/uv/install.sh | sh
    - source $HOME/.local/bin/env
    - uv tool install "pipecat-ai[cli]" --with pipecatcloud
    - pipecat cloud deploy my-agent --yes
```

GitLab automatically exposes CI/CD variables as environment variables, so the CLI picks up `PIPECAT_TOKEN` without additional configuration.

## Security considerations

* **Treat PATs like passwords.** Anyone with your token can act as you.
* **Use your CI platform's secret store.** Never commit tokens to source control.
* **Scope tokens to purpose.** Create separate PATs for different pipelines so you can revoke them independently.
* **Rotate periodically.** Delete old tokens from the dashboard and generate new ones.

## Next steps

<CardGroup cols={2}>
  <Card title="CI with GitHub Actions" icon="github" href="./ci-with-github-actions">
    Automate deploys with the official GitHub Action.
  </Card>

  <Card title="Accounts and Organizations" icon="people-group" href="../fundamentals/accounts-and-organizations">
    Learn about organizations, API keys, and access control.
  </Card>
</CardGroup>