@apicity/openai
v0.7.3
Published
OpenAI / GPT provider for chat completions.
Readme
@apicity/openai
OpenAI / GPT provider for chat completions.
Runtime dependencies:
zod@^4.4.3— request schemas attached to every POST endpoint as.schema
Installation
npm install @apicity/openai
# or
pnpm add @apicity/openaiQuick Start
import { createOpenAi } from "@apicity/openai";
const openai = createOpenAi({ apiKey: process.env.OPENAI_API_KEY! });API Reference
58 endpoints across 19 groups. Each method mirrors an upstream URL path.
audio
POST https://api.openai.com/v1/audio/speech
Cost tier: expensive
const res = await openai.v1.audio.speech({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/audio/transcriptions
Cost tier: expensive
const res = await openai.v1.audio.transcriptions({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/audio/translations
Cost tier: expensive
const res = await openai.v1.audio.translations({ /* ... */ });Source: packages/provider/openai/src/openai.ts
batches
GET https://api.openai.com/v1/batches/{idOrOpts}
Cost tier: expensive
const res = await openai.v1.batches({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/batches
Cost tier: expensive
const res = await openai.v1.batches({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/batches/{id}/cancel
Cost tier: expensive
const res = await openai.v1.batches.cancel({ /* ... */ });Source: packages/provider/openai/src/openai.ts
chat
DELETE https://api.openai.com/v1/chat/completions/{id}
Cost tier: expensive
const res = await openai.v1.chat.completions({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/chat/completions/{idOrOpts}
Cost tier: expensive
const res = await openai.v1.chat.completions({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/chat/completions/{id}/messages
Cost tier: expensive
const res = await openai.v1.chat.completions.messages({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/chat/completions/{id}
Cost tier: expensive
const res = await openai.v1.chat.completions({ /* ... */ });Source: packages/provider/openai/src/openai.ts
codex
GET https://chatgpt.com/backend-api/wham/usage
Cost tier: expensive
const res = await openai.codex.usage({ /* ... */ });Source: packages/provider/openai/src/openai.ts
completions
POST https://api.openai.com/v1/completions
Cost tier: expensive
const res = await openai.v1.completions({ /* ... */ });Source: packages/provider/openai/src/openai.ts
containers
POST https://api.openai.com/v1/containers
Cost tier: expensive
const res = await openai.v1.containers({ /* ... */ });Source: packages/provider/openai/src/openai.ts
conversations
GET https://api.openai.com/v1/conversations/{conversationId}
Cost tier: expensive
const res = await openai.v1.conversations.retrieve({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/conversations
Cost tier: expensive
const res = await openai.v1.conversations({ /* ... */ });Source: packages/provider/openai/src/openai.ts
embeddings
POST https://api.openai.com/v1/embeddings
Cost tier: expensive
const res = await openai.v1.embeddings({ /* ... */ });Source: packages/provider/openai/src/openai.ts
evals
POST https://api.openai.com/v1/evals
Cost tier: expensive
const res = await openai.v1.evals({ /* ... */ });Source: packages/provider/openai/src/openai.ts
files
DELETE https://api.openai.com/v1/files/{id}
Cost tier: expensive
const res = await openai.v1.files({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/files/{idOrOpts}
Cost tier: expensive
const res = await openai.v1.files({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/files/{id}/content
Cost tier: expensive
const res = await openai.v1.files.content({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/files
Cost tier: expensive
const res = await openai.v1.files({ /* ... */ });Source: packages/provider/openai/src/openai.ts
fineTuning
DELETE https://api.openai.com/v1/fine_tuning/checkpoints/{checkpoint}/permissions/{permissionId}
Cost tier: expensive
const res = await openai.v1.fineTuning.checkpoints.permissions({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/fine_tuning/checkpoints/{checkpoint}/permissions
Cost tier: expensive
const res = await openai.v1.fineTuning.checkpoints.permissions({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/fine_tuning/jobs/{idOrOpts}
Cost tier: expensive
const res = await openai.v1.fineTuning.jobs({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/fine_tuning/jobs/{id}/checkpoints
Cost tier: expensive
const res = await openai.v1.fineTuning.jobs.checkpoints({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/fine_tuning/jobs/{id}/events
Cost tier: expensive
const res = await openai.v1.fineTuning.jobs.events({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/fine_tuning/checkpoints/{checkpoint}/permissions
Cost tier: expensive
const res = await openai.v1.fineTuning.checkpoints.permissions({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/fine_tuning/jobs
Cost tier: expensive
const res = await openai.v1.fineTuning.jobs({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/fine_tuning/jobs/{id}/cancel
Cost tier: expensive
const res = await openai.v1.fineTuning.jobs.cancel({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/fine_tuning/jobs/{id}/pause
Cost tier: expensive
const res = await openai.v1.fineTuning.jobs.pause({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/fine_tuning/jobs/{id}/resume
Cost tier: expensive
const res = await openai.v1.fineTuning.jobs.resume({ /* ... */ });Source: packages/provider/openai/src/openai.ts
images
POST https://api.openai.com/v1/images/edits
Cost tier: expensive
const res = await openai.v1.images.edits({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/images/generations
Cost tier: expensive
const res = await openai.v1.images.generations({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/images/variations
Cost tier: expensive
const res = await openai.v1.images.variations({ /* ... */ });Source: packages/provider/openai/src/openai.ts
models
DELETE https://api.openai.com/v1/models/{id}
Cost tier: expensive
const res = await openai.v1.models({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/models/{id}
Cost tier: expensive
const res = await openai.v1.models({ /* ... */ });Source: packages/provider/openai/src/openai.ts
moderations
POST https://api.openai.com/v1/moderations
Cost tier: expensive
const res = await openai.v1.moderations({ /* ... */ });Source: packages/provider/openai/src/openai.ts
organization
GET https://api.openai.com/v1/organization/costs
Cost tier: expensive
const res = await openai.v1.organization.costs({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/organization/projects/{idOrOpts}
Cost tier: expensive
const res = await openai.v1.organization.projects({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/organization/projects/{projectId}/rate_limits
Cost tier: expensive
const res = await openai.v1.organization.projects.rateLimits({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/organization/usage/audio_speeches
Cost tier: expensive
const res = await openai.v1.organization.usage.audioSpeeches({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/organization/usage/audio_transcriptions
Cost tier: expensive
const res = await openai.v1.organization.usage.audioTranscriptions({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/organization/usage/code_interpreter_sessions
Cost tier: expensive
const res = await openai.v1.organization.usage.codeInterpreterSessions({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/organization/usage/completions
Cost tier: expensive
const res = await openai.v1.organization.usage.completions({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/organization/usage/embeddings
Cost tier: expensive
const res = await openai.v1.organization.usage.embeddings({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/organization/usage/images
Cost tier: expensive
const res = await openai.v1.organization.usage.images({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/organization/usage/moderations
Cost tier: expensive
const res = await openai.v1.organization.usage.moderations({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/organization/usage/vector_stores
Cost tier: expensive
const res = await openai.v1.organization.usage.vectorStores({ /* ... */ });Source: packages/provider/openai/src/openai.ts
realtime
POST https://api.openai.com/v1/realtime/client_secrets
Cost tier: expensive
const res = await openai.v1.realtime.clientSecrets({ /* ... */ });Source: packages/provider/openai/src/openai.ts
responses
DELETE https://api.openai.com/v1/responses/{id}
Cost tier: expensive
const res = await openai.v1.responses({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/responses/{id}
Cost tier: expensive
const res = await openai.v1.responses({ /* ... */ });Source: packages/provider/openai/src/openai.ts
GET https://api.openai.com/v1/responses/{id}/input_items
Cost tier: expensive
const res = await openai.v1.responses.inputItems({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/responses
Cost tier: expensive
const res = await openai.v1.responses({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/responses/{id}/cancel
Cost tier: expensive
const res = await openai.v1.responses.cancel({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/responses/compact
Cost tier: expensive
const res = await openai.v1.responses.compact({ /* ... */ });Source: packages/provider/openai/src/openai.ts
POST https://api.openai.com/v1/responses/input_tokens
Cost tier: expensive
const res = await openai.v1.responses.inputTokens({ /* ... */ });Source: packages/provider/openai/src/openai.ts
uploads
POST https://api.openai.com/v1/uploads
Cost tier: expensive
const res = await openai.v1.uploads({ /* ... */ });Source: packages/provider/openai/src/openai.ts
vectorStores
POST https://api.openai.com/v1/vector_stores
Cost tier: expensive
const res = await openai.v1.vectorStores({ /* ... */ });Source: packages/provider/openai/src/openai.ts
Middleware
import { createOpenAi, withRetry } from "@apicity/openai";
const openai = createOpenAi({ apiKey: process.env.OPENAI_API_KEY! });
const models = withRetry(openai.get.v1.models, { retries: 3 });Part of the apicity monorepo.
License
MIT — see LICENSE.