OpenAIModelProviderOptions

import type { OpenAIModelProviderOptions } from "@elie-laloum/outpost";

Parameters and properties

apiOptional
"chat-completions" | "responses" | undefined
HTTP protocol: chat-completions by default, or responses. No automatic protocol fallback.
baseUrlRequired
string
Absolute HTTP(S) base URL including its version prefix, such as https://api.openai.com/v1; chat/completions or responses is appended. Credentials, query or fragment fail with code configuration, and redirects are refused.
apiKeyRequired
string | false
Explicit bearer API key, or false for an unauthenticated endpoint. No environment variable or account login is read automatically.
timeoutMsOptional
number | undefined
Request deadline in milliseconds, default 120000, at most 2147483647. While streaming it restarts on each received chunk; expiry rejects with code timeout.
maxResponseBytesOptional
number | undefined
Maximum response body in bytes after decompression, default 8388608 (8 MiB); a streamed response counts all its chunks. A larger response fails with code response.

export interface OpenAIModelProviderOptions extends HttpModelOptions {
  readonly api?: "chat-completions" | "responses";
}