Overview - Corsair

Use Spotify through Corsair: one client, typed API calls, optional local DB sync. What you get:

30 typed API operations
6 database entities synced for fast .search() / .list() queries

Setup

Install

pnpm install @corsair-dev/spotify

Add the plugin

Solo
Multi-Tenant

corsair.ts

import { createCorsair } from 'corsair';
import { spotify } from '@corsair-dev/spotify';

export const corsair = createCorsair({
	// ... other config options,
	multiTenancy: false,
    plugins: [spotify()],
});

corsair.ts

import { createCorsair } from 'corsair';
import { spotify } from '@corsair-dev/spotify';

export const corsair = createCorsair({
	// ... other config options,
    multiTenancy: true,
    plugins: [spotify()],
});

See Multi-tenancy for account isolation.

Get credentials

Follow Get Credentials if you need help getting keys.

Store credentials

Solo
Multi-Tenant

pnpm corsair setup --plugin=spotify

Use the key names documented in Get Credentials (for example api_key=, bot_token=, or OAuth client fields).

pnpm corsair setup --plugin=spotify --tenant=<tenantId>

Store per-tenant secrets after you create the tenant record. See Multi-tenancy.

Authentication

Each tab shows how to register the plugin for that authentication method. The default authType from the plugin does not need to appear in the factory call.

OAuth 2.0 (Default)
API Key

corsair.ts

spotify()

Store credentials with pnpm corsair setup --plugin=spotify (see Get Credentials for field names). For OAuth, you typically store integration keys at the provider level and tokens per account or tenant.More: OAuth 2.0

corsair.ts

spotify({
    authType: 'api_key',
})

Query synced data

Synced entities support corsair.spotify.db.<entity>.search() and .list(). See Database for filters and operators.

Example API calls

Read-style (read): albums.get

await corsair.spotify.api.albums.get({});

Write-style (write): player.addToQueue

await corsair.spotify.api.player.addToQueue({});

See the full list on the API page. Use pnpm corsair list --plugin=spotify and pnpm corsair schema <path> locally to inspect schemas.

Hooks

Use hooks on API calls and webhookHooks on incoming events to add logging, approvals, or side effects. See Hooks and Webhooks for routing and payload patterns.

Reference

Topic	Link
API	API
Database	Database
Credentials	Get credentials

​Setup

​Authentication

​Query synced data

​Example API calls

​Hooks

​Reference

Setup

Authentication

Query synced data

Example API calls

Hooks

Reference