> ## Documentation Index
> Fetch the complete documentation index at: https://corsair-feat-reconnect-error.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Overview

> Youtube plugin for Corsair

Use **Youtube** through Corsair: one client, typed API calls, local DB sync.

**What you get:**

* 51 typed API operations
* 8 synced entities (`activities`, `captions`, `channels`, `comments`, `playlistItems`, `playlists`, and 2 more) for fast `.search()` / `.list()`

## Setup

<Steps>
  <Step title="Install">
    <CodeGroup>
      ```bash npm theme={null}
      npm install corsair @corsair-dev/youtube
      ```

      ```bash yarn theme={null}
      yarn add corsair @corsair-dev/youtube
      ```

      ```bash pnpm theme={null}
      pnpm install corsair @corsair-dev/youtube
      ```

      ```bash bun theme={null}
      bun add corsair @corsair-dev/youtube
      ```
    </CodeGroup>
  </Step>

  <Step title="Add the plugin">
    ```ts corsair.ts theme={null}
    import Database from 'better-sqlite3';
    import { createCorsair } from 'corsair';
    import { youtube } from '@corsair-dev/youtube';

    export const corsair = createCorsair({
    	plugins: [
    		youtube(),
    	],
    	database: new Database('corsair.db'),
    	kek: process.env.CORSAIR_KEK!,
    	hub: {
    		projectApiKey: process.env.CORSAIR_DEV_API_KEY!,
    		signingSecret: process.env.CORSAIR_DEV_SIGNING_SECRET!,
    	},
    });
    ```

    Multi-tenancy is the default — scope calls with `corsair.withTenant(id)`. See [Quick start](/quick-start) for KEK + Hub keys, and [Multi-tenancy](/concepts/multi-tenancy) for account isolation.
  </Step>

  <Step title="Choose authentication">
    <Tabs>
      <Tab title="OAuth 2.0 (Recommended)">
        Open [hub.corsair.dev](https://hub.corsair.dev/dashboard), navigate to your project, and enter the **client ID** and **client secret** from your Youtube OAuth app.

        Provider walkthrough: [Get Credentials](/plugins/youtube/get-credentials).

        ```ts theme={null}
        youtube()
        ```

        More: [OAuth 2.0](/concepts/oauth)
      </Tab>
    </Tabs>
  </Step>

  <Step title="Connect a tenant">
    Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see [Connect / OAuth](/management/connect).

    ```ts theme={null}
    const { connectUrl } = await corsair.manage.connect.createLink({
    	plugin: 'youtube',
    	tenantId: 'acme',
    });
    // redirect the user's browser to connectUrl
    ```
  </Step>
</Steps>

## Example API calls

**`captions.list`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.youtube.api.captions.list({});
```

**`captions.update`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.youtube.api.captions.update({});
```

See the full list on the [API](/plugins/youtube/api) page.

## Query synced data

Synced entities support `tenant.youtube.db.<entity>.search()` and `.list()`: `activities`, `captions`, `channels`, `comments`, `playlistItems`, `playlists`, `subscriptions`, `videos`.

See [Database](/plugins/youtube/database) for filters and operators.

## What's next

<CardGroup cols={2}>
  <Card title="API reference" href="/plugins/youtube/api">
    Every `youtube.api.*` operation with input and output types.
  </Card>

  <Card title="Database" href="/plugins/youtube/database">
    Synced entities, search filters, and operators.
  </Card>

  <Card title="Connect / OAuth" href="/management/connect">
    createLink, Hub delivery, and tenant connect flows.
  </Card>

  <Card title="Use with agents" href="/mcp-adapters/mcp-adapters">
    Expose this plugin's operations as MCP tools.
  </Card>

  <Card title="Get credentials" href="/plugins/youtube/get-credentials">
    Provider-console walkthrough for keys and OAuth apps.
  </Card>
</CardGroup>