OpenAIClientOptionsWithAzureAgent interface

Azure Agent endpoint configuration.

azureConfig?: AzureAgentConfig

Property Value

Defaults to process.env['OPENAI_ADMIN_KEY'].

adminAPIKey?: string | null

Property Value

Inherited From OpenAIClientOptions.adminAPIKey

API key used for authentication.

• Accepts either a static string or an async function that resolves to a string.
• Defaults to process.env['OPENAI_API_KEY'].
• When a function is provided, it is invoked when building bearer authentication headers for each attempt, including retries and direct buildRequest() calls. Each invocation's result is used for its own request.
• The function must return a non-empty string; otherwise an OpenAIError is thrown.
• If the function throws, the error is wrapped in an OpenAIError with the original error available as cause.
• Mutually exclusive with workloadIdentity.

apiKey?: string | ApiKeySetter | null

Property Value

Inherited From OpenAIClientOptions.apiKey

Override the default base URL for the API, e.g., "https://api.example.com/v2/"

Defaults to process.env['OPENAI_BASE_URL'].

baseURL?: string | null

Property Value

Inherited From OpenAIClientOptions.baseURL

First-class certificate credential created with fromX509 from openai/auth/x509-transport.

credential?: X509Credential

Property Value

Inherited From OpenAIClientOptions.credential

By default, client-side use of this library is not allowed, as it risks exposing your secret API credentials to attackers. Only set this option to true if you understand the risks and have appropriate mitigations in place.

dangerouslyAllowBrowser?: boolean

Property Value

Inherited From OpenAIClientOptions.dangerouslyAllowBrowser

Select an OpenAI regional endpoint. This overrides an inherited or environment base URL and is mutually exclusive with an explicit baseURL or provider. Availability depends on your project and model; no fallback is performed. null and undefined leave ordinary base URL resolution unchanged.

dataResidency?: DataResidency | null

Property Value

Inherited From OpenAIClientOptions.dataResidency

Default headers to include with every request to the API.

These can be removed in individual requests by explicitly setting the header to null in request options.

defaultHeaders?: HeadersLike

Property Value

Inherited From OpenAIClientOptions.defaultHeaders

Default query parameters to include with every request to the API.

These can be removed in individual requests by explicitly setting the param to undefined in request options.

defaultQuery?: Record<string, string | undefined>

Property Value

Inherited From OpenAIClientOptions.defaultQuery

Specify a custom fetch function implementation.

If not provided, we expect that fetch is defined globally.

fetch?: Fetch

Property Value

Inherited From OpenAIClientOptions.fetch

Additional RequestInit options to be passed to fetch calls. Properties will be overridden by per-request fetchOptions.

fetchOptions?: MergedRequestInit

Property Value

Inherited From OpenAIClientOptions.fetchOptions

Set the logger.

Defaults to globalThis.console.

logger?: Logger

Property Value

Inherited From OpenAIClientOptions.logger

Set the log level.

Defaults to process.env['OPENAI_LOG'] or 'warn' if it isn't set.

logLevel?: LogLevel

Property Value

Inherited From OpenAIClientOptions.logLevel

The maximum number of times that the client will retry a request in case of a temporary failure, like a network error or a 5XX error from the server.

maxRetries?: number

Property Value

Inherited From OpenAIClientOptions.maxRetries

Defaults to process.env['OPENAI_ORG_ID'].

organization?: string | null

Property Value

Inherited From OpenAIClientOptions.organization

Defaults to process.env['OPENAI_PROJECT_ID'].

project?: string | null

Property Value

Inherited From OpenAIClientOptions.project

Configure this client to use a third-party API provider. Mutually exclusive with top-level authentication and baseURL options.

provider?: Provider

Property Value

Inherited From OpenAIClientOptions.provider

The maximum amount of time (in milliseconds) that the client should wait for a response from the server before timing out a single request.

Note that request timeouts are retried by default, so in a worst-case scenario you may wait much longer than this timeout before the promise succeeds or fails.

Node.js fetch enforces independent response-header and body-inactivity timeouts, typically defaulting to five minutes, even when this timeout is longer. To increase them, install undici and configure an Agent with the matching fetch implementation:

import { Agent, fetch } from 'undici';

const timeout = 20 * 60 * 1000;
const client = new OpenAI({
  timeout,
  fetch,
  fetchOptions: {
    dispatcher: new Agent({ headersTimeout: timeout, bodyTimeout: timeout }),
  },
});

timeout?: number

Property Value

Inherited From OpenAIClientOptions.timeout

Defaults to process.env['OPENAI_WEBHOOK_SECRET'].

webhookSecret?: string | null

Property Value

Inherited From OpenAIClientOptions.webhookSecret

Workload identity configuration for OAuth2 token exchange authentication. Mutually exclusive with apiKey.

workloadIdentity?: WorkloadIdentity | X509WorkloadIdentity

Property Value

Inherited From OpenAIClientOptions.workloadIdentity

Approved, frozen Node.js certificate transport required only for X.509 workload identity.

x509Transport?: X509Transport

Property Value

Inherited From OpenAIClientOptions.x509Transport