Optional
apiOptional
baseURLOverride the default base URL for the API, e.g., "https://api.example.com/v2/"
Defaults to process.env['OPENAI_BASE_URL'].
Optional
dangerouslyBy 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.
Optional
defaultDefault 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.
Optional
defaultDefault 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.
Optional
fetchSpecify a custom fetch
function implementation.
If not provided, we expect that fetch
is defined globally.
Optional
fetchAdditional RequestInit
options to be passed to fetch
calls.
Properties will be overridden by per-request fetchOptions
.
Optional
logSet the log level.
Defaults to process.env['OPENAI_LOG'] or 'warn' if it isn't set.
Optional
loggerSet the logger.
Defaults to globalThis.console.
Optional
maxThe 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.
Optional
organizationDefaults to process.env['OPENAI_ORG_ID'].
Optional
projectDefaults to process.env['OPENAI_PROJECT_ID'].
Optional
timeoutThe 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.
Defaults to process.env['OPENAI_API_KEY'].