Overview - Corsair

Use Cloudinary through Corsair: one client, typed API calls, optional local DB sync, and incoming webhooks documented below. What you get:

110 typed API operations
10 database entities synced for fast .search() / .list() queries
13 incoming webhook event types

Setup

Install

pnpm install @corsair-dev/cloudinary

Add the plugin

Solo
Multi-Tenant

corsair.ts

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

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

corsair.ts

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

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

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=cloudinary

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

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

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

Authentication

See Get Credentials for how to obtain and store secrets. Auth methods depend on how you configure cloudinary({ ... }) — check the plugin source *PluginOptions type for supported authType values.

Webhooks

This plugin registers 13 webhook handler(s). Configure your provider to POST events to your Corsair HTTP endpoint, then use webhookHooks in the plugin factory for custom logic. See Webhooks for every event path and payload shape, and Webhooks concept for how to set up routing.

Query synced data

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

Example API calls

Read-style (read): adaptive.getAdaptiveStreamingProfiles

await corsair.cloudinary.api.adaptive.getAdaptiveStreamingProfiles({});

Write-style (write): asset.createAssetRelationsByAssetId

await corsair.cloudinary.api.asset.createAssetRelationsByAssetId({});

See the full list on the API page. Use pnpm corsair list --plugin=cloudinary 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 the Webhooks page for payload types.

Reference

Topic	Link
API	API
Database	Database
Webhooks	Webhooks
Credentials	Get credentials

​Setup

​Authentication

​Webhooks

​Query synced data

​Example API calls

​Hooks

​Reference