TypeScript SDK

@bimpeai/sdk is the official TypeScript client for the BimpeAI Agent Console API. It has no runtime dependencies and is built on the platform fetch, so it runs on Node 24+, Bun, Deno, modern browsers, Cloudflare Workers, and Vercel Edge. Requests and responses are fully typed, and the package ships both ESM and CommonJS with bundled type declarations.

Install

pnpm add @bimpeai/sdk

npm install @bimpeai/sdk

yarn add @bimpeai/sdk

Quickstart

import { BimpeAI } from '@bimpeai/sdk';

const bimpe = new BimpeAI({ apiKey: process.env.BIMPEAI_API_KEY! });

const agents = await bimpe.agents.list();
for (const agent of agents.data) console.log(agent.id, agent.name);

Authentication

Pass your team API key when you construct the client. The SDK sends it as Authorization: Bearer <key>; keys are prefixed sk_. The key is required — constructing a client without one throws UserError before any request goes out. The SDK does not read the key from the environment, so read it yourself and pass it in.

const bimpe = new BimpeAI({ apiKey: 'sk_…' });

A scope-restricted key (for example one limited to workflows:read) works the same way. A call that falls outside the key's scope throws PermissionDeniedError.