Configuration

Configure OpenAIClient once, then create capability-specific model objects.

Client options

Option	Purpose
apiKey	Credential used when client is not supplied.
baseUrl	Replaces the OpenAI API base URL and defaults completion to Chat.
headers	Adds default SDK headers.
completionApi	Forces 'responses' or 'chat'.
client	Reuses an initialized official OpenAI SDK client.

const openai = new OpenAIClient({
  apiKey: process.env.OPENAI_API_KEY,
  completionApi: 'responses',
  headers: {
    'X-Application': 'support-api',
  },
})

When client is provided, its transport, retry, timeout, and connection settings remain owned by the official SDK instance.

Completion request options

Use normal Anvia completion or prompt request methods for messages, tools, schemas, temperature, token limits, and cancellation. Provider-only fields belong in additionalParams:

const response = await model.completion({
  chatHistory,
  documents: [],
  tools: [],
  additionalParams: {
    reasoning: { effort: 'high' },
  },
})

Only send fields supported by the selected OpenAI API and model. additionalParams is a pass-through, not cross-provider validation.

Embedding options

const embeddings = openai.embeddingModel('text-embedding-3-small', {
  dimensions: 768,
  user: 'tenant-safe-correlation-id',
  maxBatchSize: 128,
})

maxBatchSize controls application batching, not provider concurrency. Keep it within endpoint limits. Do not put secrets or raw customer data into user merely for logging convenience.

Media options

Image, speech, and transcription requests accept additionalParams. These objects are merged into the provider request, so provider fields can override adapter defaults. Use this intentionally and test the resulting media type and output shape.

Runtime and production

The package is ESM, includes TypeScript declarations, peers on @anvia/core >=0.7.1 <1.0.0, and uses the official openai SDK. Keep it in a trusted server runtime. If an edge runtime is required, validate the official SDK, upload APIs, binary handling, and streaming behavior in that exact environment.