# @apicity/openai 中文文档

规范地址：https://npmcn.com/package/%40apicity/openai/

版本：0\.27\.0
npm 元数据更新时间：2026-11-06T09:56:15.391Z
中文译文更新时间：2026-11-06T10:07:35.572Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40apicity/openai
原文对照：https://npmcn.com/package/%40apicity/openai/?lang=original
项目主页：https://github.com/justintanner/apicity#readme
源码仓库：https://github.com/justintanner/apicity

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：519 kB，43 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：2 个
- 首次发布：2026-05-11T01:52:20.506Z
- 最新版本发布：2026-11-06T09:56:15.193Z
- 近 30 天下载量：4740（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：90（近 12 个月 90 个）

## 中文简介

OpenAI / GPT 服务器,用于聊天完成 .

## 安装

```sh
npm install @apicity/openai
```

也可以使用：`pnpm add @apicity/openai`、`yarn add @apicity/openai`、`bun add @apicity/openai`

## README

# @ apicity/ openai (英语)

[![npm](https://img.shields.io/npm/v/@apicity/openai?color=cb0000)](https://www.npmjs.com/package/@apicity/openai) [![dependencies](https://img.shields.io/badge/dependencies-2-blue)](https://npmcn.com/package/%40apicity/openai/package.json) [![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue?logo=typescript&logoColor=white)](https://npmcn.com/package/%40apicity/openai/tsconfig.json)

OpenAI / GPT 服务器,用于聊天完成 .

WebRTC 上的实时语音 : `openai.post.v1.realtime.calls({ sdp, session })` 将浏览器的 SDP 提供并解析给 SDP 答案 加上 `callId` (从 `Location` 头曰. 这个 `@apicity/openai/realtime` 子路径导出 `connectOpenAiRealtime`,它打开了服务器侧的WebSocket对那个呼叫(`callId`)或改为新的届会(第1款)`model`: `send()` 客户端事件,例如 `session.update`,然后通过 `onEvent`。 。 。 . `openai.post.v1.realtime.calls.hangup(callId)` 结束通话.

运行时间依赖性 :

-   `ws@^8.21.0` —— 用于实时服务器控制频道的 WebSocket 客户端 `@apicity/openai/realtime`
-   `zod@^4.6.6` - 请求在每一个 POST 端点上附加计划 `.schema`

## 安装

```bash
npm install @apicity/openai
# or
pnpm add @apicity/openai
```

## 快速启动

```typescript
import { createOpenAi } from "@apicity/openai";

const openai = createOpenAi({ apiKey: process.env.OPENAI_API_KEY! });
```

## API 参考

共有19组64个终点. 每个方法都映射出上游的 URL 路径 .

### 音频

`POST` **`openai.v1.audio.speech`**

`POST [https://api.openai.com/v1/audio/speech](https://api.openai.com/v1/audio/speech)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.audio.speech({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.audio.transcriptions`**

`POST [https://api.openai.com/v1/audio/transcriptions](https://api.openai.com/v1/audio/transcriptions)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.audio.transcriptions({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.audio.translations`**

`POST [https://api.openai.com/v1/audio/translations](https://api.openai.com/v1/audio/translations)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.audio.translations({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 批号

`GET` **`openai.v1.batches`**

`GET https://api.openai.com/v1/batches/{idOrOpts}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.get.v1.batches({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.batches`**

`POST [https://api.openai.com/v1/batches](https://api.openai.com/v1/batches)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.batches({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.batches.cancel`**

`POST https://api.openai.com/v1/batches/{id}/cancel`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.batches.cancel({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 聊天

`DELETE` **`openai.v1.chat.completions`**

`DELETE https://api.openai.com/v1/chat/completions/{id}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.delete.v1.chat.completions({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.chat.completions`**

`GET https://api.openai.com/v1/chat/completions/{idOrOpts}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.get.v1.chat.completions({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.chat.completions.messages`**

`GET https://api.openai.com/v1/chat/completions/{id}/messages`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.get.v1.chat.completions.messages({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.chat.completions`**

`POST https://api.openai.com/v1/chat/completions/{id}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.chat.completions({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 代码

`GET` **`openai.codex.usage`**

`GET [https://chatgpt.com/backend-api/wham/usage](https://chatgpt.com/backend-api/wham/usage)`

成本等级 : `expensive`

[上游区域](https://developers.openai.com/codex/pricing)

```typescript
const res = await openai.get.codex.usage();
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 完成数

`POST` **`openai.v1.completions`**

`POST [https://api.openai.com/v1/completions](https://api.openai.com/v1/completions)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/completions/create)

```typescript
const res = await openai.post.v1.completions({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 集装箱

`POST` **`openai.v1.containers`**

`POST [https://api.openai.com/v1/containers](https://api.openai.com/v1/containers)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/containers/createContainers)

```typescript
const res = await openai.post.v1.containers({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 对话

`GET` **`openai.v1.conversations.retrieve`**

`GET https://api.openai.com/v1/conversations/{conversationId}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/conversations/retrieve)

```typescript
const res = await openai.get.v1.conversations.retrieve({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.conversations`**

`POST [https://api.openai.com/v1/conversations](https://api.openai.com/v1/conversations)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.conversations({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 嵌入

`POST` **`openai.v1.embeddings`**

`POST [https://api.openai.com/v1/embeddings](https://api.openai.com/v1/embeddings)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.embeddings({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### evals (中文)

`POST` **`openai.v1.evals`**

`POST [https://api.openai.com/v1/evals](https://api.openai.com/v1/evals)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/evals/create)

```typescript
const res = await openai.post.v1.evals({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 文件

`DELETE` **`openai.v1.files`**

`DELETE https://api.openai.com/v1/files/{id}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.delete.v1.files({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.files`**

`GET https://api.openai.com/v1/files/{idOrOpts}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.get.v1.files({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.files.content`**

`GET https://api.openai.com/v1/files/{id}/content`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.get.v1.files.content({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.files`**

`POST [https://api.openai.com/v1/files](https://api.openai.com/v1/files)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.files({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 微调

`DELETE` **`openai.v1.fineTuning.checkpoints.permissions`**

`DELETE https://api.openai.com/v1/fine_tuning/checkpoints/{checkpoint}/permissions/{permissionId}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.delete.v1.fineTuning.checkpoints.permissions({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.fineTuning.checkpoints.permissions`**

`GET https://api.openai.com/v1/fine_tuning/checkpoints/{checkpoint}/permissions`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.get.v1.fineTuning.checkpoints.permissions({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.fineTuning.jobs`**

`GET https://api.openai.com/v1/fine_tuning/jobs/{idOrOpts}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.get.v1.fineTuning.jobs({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.fineTuning.jobs.checkpoints`**

`GET https://api.openai.com/v1/fine_tuning/jobs/{id}/checkpoints`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.get.v1.fineTuning.jobs.checkpoints({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.fineTuning.jobs.events`**

`GET https://api.openai.com/v1/fine_tuning/jobs/{id}/events`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.get.v1.fineTuning.jobs.events({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.fineTuning.checkpoints.permissions`**

`POST https://api.openai.com/v1/fine_tuning/checkpoints/{checkpoint}/permissions`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.fineTuning.checkpoints.permissions({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.fineTuning.jobs`**

`POST [https://api.openai.com/v1/fine_tuning/jobs](https://api.openai.com/v1/fine_tuning/jobs)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.fineTuning.jobs({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.fineTuning.jobs.cancel`**

`POST https://api.openai.com/v1/fine_tuning/jobs/{id}/cancel`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.fineTuning.jobs.cancel({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.fineTuning.jobs.pause`**

`POST https://api.openai.com/v1/fine_tuning/jobs/{id}/pause`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.fineTuning.jobs.pause({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.fineTuning.jobs.resume`**

`POST https://api.openai.com/v1/fine_tuning/jobs/{id}/resume`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.fineTuning.jobs.resume({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 图像

`POST` **`openai.v1.images.edits`**

`POST [https://api.openai.com/v1/images/edits](https://api.openai.com/v1/images/edits)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.images.edits({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.images.generations`**

`POST [https://api.openai.com/v1/images/generations](https://api.openai.com/v1/images/generations)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.images.generations({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.images.variations`**

`POST [https://api.openai.com/v1/images/variations](https://api.openai.com/v1/images/variations)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.images.variations({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 模型

`DELETE` **`openai.v1.models`**

`DELETE https://api.openai.com/v1/models/{id}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.delete.v1.models({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.models`**

`GET https://api.openai.com/v1/models/{id}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.get.v1.models({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 温和

`POST` **`openai.v1.moderations`**

`POST [https://api.openai.com/v1/moderations](https://api.openai.com/v1/moderations)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.moderations({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 组织

`GET` **`openai.v1.organization.costs`**

`GET [https://api.openai.com/v1/organization/costs](https://api.openai.com/v1/organization/costs)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/usage)

```typescript
const res = await openai.get.v1.organization.costs({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.organization.projects`**

`GET https://api.openai.com/v1/organization/projects/{idOrOpts}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/projects)

```typescript
const res = await openai.get.v1.organization.projects({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.organization.projects.rateLimits`**

`GET https://api.openai.com/v1/organization/projects/{projectId}/rate_limits`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/project-rate-limits)

```typescript
const res = await openai.get.v1.organization.projects.rateLimits({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.organization.usage.audioSpeeches`**

`GET [https://api.openai.com/v1/organization/usage/audio_speeches](https://api.openai.com/v1/organization/usage/audio_speeches)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/usage)

```typescript
const res = await openai.get.v1.organization.usage.audioSpeeches({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.organization.usage.audioTranscriptions`**

`GET [https://api.openai.com/v1/organization/usage/audio_transcriptions](https://api.openai.com/v1/organization/usage/audio_transcriptions)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/usage)

```typescript
const res = await openai.get.v1.organization.usage.audioTranscriptions({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.organization.usage.codeInterpreterSessions`**

`GET [https://api.openai.com/v1/organization/usage/code_interpreter_sessions](https://api.openai.com/v1/organization/usage/code_interpreter_sessions)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/usage)

```typescript
const res = await openai.get.v1.organization.usage.codeInterpreterSessions({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.organization.usage.completions`**

`GET [https://api.openai.com/v1/organization/usage/completions](https://api.openai.com/v1/organization/usage/completions)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/usage)

```typescript
const res = await openai.get.v1.organization.usage.completions({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.organization.usage.embeddings`**

`GET [https://api.openai.com/v1/organization/usage/embeddings](https://api.openai.com/v1/organization/usage/embeddings)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/usage)

```typescript
const res = await openai.get.v1.organization.usage.embeddings({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.organization.usage.images`**

`GET [https://api.openai.com/v1/organization/usage/images](https://api.openai.com/v1/organization/usage/images)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/usage)

```typescript
const res = await openai.get.v1.organization.usage.images({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.organization.usage.moderations`**

`GET [https://api.openai.com/v1/organization/usage/moderations](https://api.openai.com/v1/organization/usage/moderations)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/usage)

```typescript
const res = await openai.get.v1.organization.usage.moderations({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.organization.usage.vectorStores`**

`GET [https://api.openai.com/v1/organization/usage/vector_stores](https://api.openai.com/v1/organization/usage/vector_stores)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/usage)

```typescript
const res = await openai.get.v1.organization.usage.vectorStores({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 实时

`POST` **`openai.v1.realtime.calls`**

`POST [https://api.openai.com/v1/realtime/calls](https://api.openai.com/v1/realtime/calls)`

成本等级 : `expensive`

[上游区域](https://developers.openai.com/api/docs/guides/voice-webrtc)

```typescript
const res = await openai.post.v1.realtime.calls({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.realtime.calls.hangup`**

`POST https://api.openai.com/v1/realtime/calls/{call_id}/hangup`

成本等级 : `expensive`

[上游区域](https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/hangup)

```typescript
const res = await openai.post.v1.realtime.calls.hangup({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.realtime.clientSecrets`**

`POST [https://api.openai.com/v1/realtime/client_secrets](https://api.openai.com/v1/realtime/client_secrets)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/realtime-sessions/create-client-secret)

```typescript
const res = await openai.post.v1.realtime.clientSecrets({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 答复

`DELETE` **`openai.v1.responses`**

`DELETE https://api.openai.com/v1/responses/{id}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.delete.v1.responses({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.responses`**

`GET https://api.openai.com/v1/responses/{id}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.get.v1.responses({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.responses.inputItems`**

`GET https://api.openai.com/v1/responses/{id}/input_items`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.get.v1.responses.inputItems({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.responses`**

`POST [https://api.openai.com/v1/responses](https://api.openai.com/v1/responses)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.responses({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.responses.cancel`**

`POST https://api.openai.com/v1/responses/{id}/cancel`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.responses.cancel({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.responses.compact`**

`POST [https://api.openai.com/v1/responses/compact](https://api.openai.com/v1/responses/compact)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.responses.compact({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.responses.inputTokens`**

`POST [https://api.openai.com/v1/responses/input_tokens](https://api.openai.com/v1/responses/input_tokens)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference)

```typescript
const res = await openai.post.v1.responses.inputTokens({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 上传

`POST` **`openai.v1.uploads`**

`POST [https://api.openai.com/v1/uploads](https://api.openai.com/v1/uploads)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/uploads/create)

```typescript
const res = await openai.post.v1.uploads({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

### 矢量种子

`GET` **`openai.v1.vectorStores`**

`GET https://api.openai.com/v1/vector_stores/{idOrOpts}`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/vector-stores/list)

```typescript
const res = await openai.get.v1.vectorStores({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`GET` **`openai.v1.vectorStores.files`**

`GET https://api.openai.com/v1/vector_stores/{vectorStoreId}/files`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/vector-stores-files/listFiles)

```typescript
const res = await openai.get.v1.vectorStores.files({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.vectorStores`**

`POST [https://api.openai.com/v1/vector_stores](https://api.openai.com/v1/vector_stores)`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/vector-stores/create)

```typescript
const res = await openai.post.v1.vectorStores({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.vectorStores.files`**

`POST https://api.openai.com/v1/vector_stores/{vectorStoreId}/files`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/vector-stores-files/createFile)

```typescript
const res = await openai.post.v1.vectorStores.files({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

`POST` **`openai.v1.vectorStores.search`**

`POST https://api.openai.com/v1/vector_stores/{vectorStoreId}/search`

成本等级 : `expensive`

[上游区域](https://platform.openai.com/docs/api-reference/vector-stores/search)

```typescript
const res = await openai.post.v1.vectorStores.search({ /* ... */ });
```

资料来源: [`packages/provider/openai/src/openai.ts`](https://npmcn.com/package/%40apicity/openai/src/openai.ts)

## 中间软件

```typescript
import { createOpenAi, withRetry } from "@apicity/openai";

const openai = createOpenAi({ apiKey: process.env.OPENAI_API_KEY! });
const models = withRetry(openai.get.v1.models, { retries: 3 });
```

部分 [辣点](https://github.com/justintanner/apicity) 单相机.

## 许可证

麻省理工学院——见 [自由主义](https://npmcn.com/package/%40apicity/openai/LICENSE)。 。 。 .

## 常见问题

### @apicity/openai 是什么？

OpenAI / GPT 服务器,用于聊天完成 \.

### 如何安装 @apicity/openai？

在项目目录运行 npm install @apicity/openai，或使用 pnpm add / yarn add / bun add。

### @apicity/openai 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @apicity/openai 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @apicity/openai 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @apicity/openai 可以商用吗？

@apicity/openai 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @apicity/openai 的下载量有多少？

根据 npm 官方下载统计，@apicity/openai 在 2026/10/06 – 2026/11/04 这 30 天内被下载 4,740 次，日均约 158 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @apicity/openai 还在维护吗？

最新版本 0\.27\.0 发布于 2026/11/06（今天）；至今共发布 90 个版本，其中过去 12 个月发布了 90 个；首次发布于 2026/05/11。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。