# openai-fetch

> OpenAI client powered by fetch

Latest version **3.4.2** (published 2025-01-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install openai-fetch
pnpm add openai-fetch
yarn add openai-fetch
bun add openai-fetch
```

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.4.2 |
| Published | 2025-01-07 |
| First published | 2022-10-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=18 |
| Dependencies | 1 |
| Unpacked size | 556.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 196 |
| Author | Riley Tomasek |
| Maintainers | fisch0920, rileytomasek |

## Links

- npm: https://www.npmjs.com/package/openai-fetch
- Repository: https://github.com/dexaai/openai-fetch
- Homepage: https://github.com/dexaai/openai-fetch#readme
- Issues: https://github.com/dexaai/openai-fetch/issues
- npm.io page: https://npm.io/package/openai-fetch

## Dependencies (1)

- [ky](https://npm.io/package/ky.md) ^1.7.4

## Recent versions

- 3.4.2 (latest) — 2025-01-07
- 3.4.1 — 2024-12-18
- 3.4.0 — 2024-12-18
- 3.3.2 — 2024-11-11
- 3.3.1 — 2024-10-08
- 3.3.0 — 2024-10-08
- 3.2.0 — 2024-10-02
- 3.1.0 — 2024-08-20
- 3.0.0 — 2024-08-08
- 2.1.0 — 2024-08-07
- 2.0.4 — 2024-07-19
- 2.0.3 — 2024-05-18
- 2.0.2 — 2024-04-21
- 2.0.1 — 2023-11-08
- 2.0.1-beta.0 — 2023-11-08
- … 30 more at https://npm.io/package/openai-fetch/versions

## README

# OpenAI Fetch Client

[![Build Status](https://github.com/rileytomasek/openai-fetch/actions/workflows/main.yml/badge.svg)](https://github.com/rileytomasek/openai-fetch/actions/workflows/main.yml) [![npm version](https://img.shields.io/npm/v/openai-fetch.svg?color=0c0)](https://www.npmjs.com/package/openai-fetch)

A minimal and opinionated OpenAI client powered by fetch.

Unfortunately, the official [openai](https://github.com/openai/openai-node) package patches fetch in problematic ways and is quite bloated.

### Reasons to consider using `openai-fetch`:

- You want a fast and small client that doesn't patch fetch
- Supports all envs with native fetch: Node 18+, browsers, Deno, Cloudflare Workers, etc
- Package size: `openai-fetch` is [~14kb](https://bundlephobia.com/package/openai-fetch) and `openai` is [~152kb](https://bundlephobia.com/package/openai)
- You only need chat, completions, embeddings, and moderations, and TTS

### Use the official `openai` package if:

- Your runtime doesn't have native fetch support
- Your app can't handle native ESM code
- You need endpoints other than chat, completions, embeddings, and moderations, and TTS
- You aren't concerned with lib size or fetch patching

## Install

```bash
npm install openai-fetch
```

This package requires `node >= 18` or an environment with `fetch` support.

This package exports [ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c). If your project uses CommonJS, consider switching to ESM or use the [dynamic `import()`](https://v8.dev/features/dynamic-import) function.

## Usage

```ts
import { OpenAIClient } from 'openai-fetch';

const client = new OpenAIClient({ apiKey: '<your api key>' });
```

The `apiKey` is optional and will be read from `process.env.OPENAI_API_KEY` if present.

## API

The API follows OpenAI very closely, so their [reference documentation](https://platform.openai.com/docs/api-reference) can generally be used. Everything is strongly typed, so you will know if anything is different as soon as TypeScript parses your code.

```ts
// Generate a single chat completion
client.createChatCompletion(params: ChatParams): Promise<ChatResponse>;

// Stream a single completion via a ReadableStream
client.streamChatCompletion(params: ChatStreamParams): Promise<ChatStreamResponse>;

// Generate one or more completions
client.createCompletions(params: CompletionParams): Promise<CompletionResponse>;

// Stream a single completion via a ReadableStream
client.streamCompletion(params: CompletionStreamParams): Promise<CompletionStreamResponse>;

// Generate one or more embeddings
client.createEmbeddings(params: EmbeddingParams): Promise<EmbeddingResponse>

// Checks for potentially harmful content
client.createModeration(params: ModerationParams): Promise<ModerationResponse>

// Text-to-Speech
client.createSpeech(params: SpeechParams): Promise<SpeechResponse>
```

### Type Definitions

The type definitions are avaible through TSServer, and can be found here: [type definitions](/src/types.ts).

## License

MIT © [Dexa](https://dexa.ai)

---
_Source: https://npm.io/package/openai-fetch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._