Skip to content
PleumRouter
Get started

AI SDK

Call PleumRouter from the Vercel AI SDK with npm package pleumrouter-ai-sdk-provider.

A thin wrapper over @ai-sdk/openai-compatible that pins base URL and API key. Use bare catalog model IDs (model list).

Install#

Install and keep keys server-side only.

terminal
npm i ai pleumrouter-ai-sdk-provider

Connect (streamText)#

Same snippet source as Quickstart — pick the AI SDK method tab.

ai-sdk.ts

Vercel AI SDK via pleumrouter-ai-sdk-provider

import { streamText } from "ai";
import { createPleum } from "pleumrouter-ai-sdk-provider";

const pleum = createPleum({
  apiKey: "plm_xxxxxxxxxxxxxxxx",
  // baseURL defaults to https://apirouter.pleum.ai/v1
});

const result = streamText({
  model: pleum("gpt-4.1"),
  prompt: "Why is the sky blue?",
});

for await (const textPart of result.textStream) {
  process.stdout.write(textPart);
}

generateText#

Use generateText when you do not need streaming.

generate-text.ts
import { generateText } from "ai";
import { pleum } from "pleumrouter-ai-sdk-provider";

// Reads PLEUM_API_KEY (and optional PLEUM_BASE_URL).
const { text } = await generateText({
  model: pleum("gpt-4.1"),
  prompt: "Hello!",
});
console.log(text);

createPleum options#

Pin gateway headers (X-Pleum-Skip-Cache, X-Pleum-User, X-Pleum-Tags) via createPleum options.

create-pleum.ts
import { createPleum } from "pleumrouter-ai-sdk-provider";

const pleum = createPleum({
  apiKey: process.env.PLEUM_API_KEY,
  baseURL: "https://apirouter.pleum.ai/v1", // default
  skipCache: false,
  user: "u-123",
  tags: ["prod", "exp-A"],
});
For Chat Completions, Messages, Responses, and Images, see Quickstart.

Next#