> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Kraken.io plugin

> Image and PDF optimization with Kraken.io - compress a file from a URL or a base64 upload, resize it, change its format, control the quality and keep chosen metadata, and read the account's plan and remaining quota.

Use **Kraken.io** through Corsair: one client, typed API calls.

Copy your API key and API secret from your Kraken.io account under API Credentials. Both are needed: Kraken authenticates with the pair, not with the key alone.

Things to know before you call:

* **The pair travels in the JSON body, not a header.** Every request carries `{"auth": {"api_key": ..., "api_secret": ...}}`. The plugin adds that block itself and never logs it, and it keeps no request body on an error, because the body holds the secret.
* **A call needs `wait` or a `callback_url`.** With `wait: true` the connection stays open and the answer carries the result. With a `callback_url` Kraken answers at once with only the job `id` (no `success` field) and posts the result, carrying the same `id`, later. A request with neither is refused, and the plugin rejects it before the call.
* **Quota is measured in bytes.** `account.status` returns `quota_total`, `quota_used` and `quota_remaining` in bytes, not in images, so divide by 1048576 for mebibytes.
* **A one-file answer is flat.** With `wait: true`, `file_name`, `kraked_url` and the sizes sit at the top level of the answer. Only a multi-size resize fills `results`, one entry per size, and there one entry can say `success: false` with a `message` while the top-level `success` is true.
* **`resize` needs a `strategy`.** Kraken refuses a resize without one, and the plugin rejects it before the call. `square` takes a `size`; the others take `width` and/or `height`. `fit` crops to fill the box; `fill` keeps the aspect ratio and pads with `background`.
* **Lossless is the default.** Leave out `lossy`, or set it to `false`, for lossless; `lossy: true` and an optional `quality` trade some fidelity for size.
* **A 200 with `success: false` is a failure.** Kraken also refuses a whole request that way, such as an unsupported format, and the plugin throws rather than returning a result with every field missing.
* **`kraked_url` is temporary.** Kraken serves an optimized file from `dl.kraken.io` for a limited time, so a caller that needs to keep it should download it.
* **Nothing is replayed.** Every call is a POST that spends quota, so a 5xx, a dropped connection or a timeout is never retried: the image may already have been fetched and billed.
* **The upload route takes base64.** A tool call carries text, so `upload.optimize` takes the file as a base64 string (a `data:` URL works too), decodes it, and sends it to Kraken as the multipart file part beside the JSON options, which is the form `/v1/upload` accepts.
* **No webhooks are handled.** A `callback_url` is where Kraken posts a result, and it is your endpoint to run, not this plugin's.

**What you get:**

* 3 typed API operations

## Setup

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/krakenio better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/krakenio better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/krakenio better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/krakenio better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { krakenio } from '@corsair-dev/krakenio';

export const corsair = createCorsair({
	plugins: [
		krakenio(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});
```

With `multiTenancy: true`, scope calls with `corsair.withTenant(id)`. See [Quick start](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Kraken.io API key before the first call: `pnpm corsair setup --plugin=krakenio --tenant=acme api_key=<your-key>` (leave out `--tenant` without `multiTenancy`), or pass it as `key` in the plugin options. With Hub, each tenant enters their own key on the connect page. See [API key auth](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> krakenio()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

**4. 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](https://docs.corsair.dev/management/connect).

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

## Example API calls

**Read the plan and remaining quota**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.krakenio.api.account.status({});
```

**Optimize an image from a URL**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.krakenio.api.url.optimize({
	url: 'https://acme.example/header.jpg',
	wait: true,
	lossy: true,
	quality: 80,
});
```

See the full list on the [API](https://docs.corsair.dev/plugins/krakenio/api.md) page.

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/krakenio/api.md)
>
> Every `krakenio.api.*` operation with input and output types.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.