Interface GenerateOptions

packages/providers/src/index.ts:33–59

type PiReasoningLevel = Exclude<ReasoningLevel, 'off'>;

export interface GenerateOptions {
  apiKey: string;
  baseUrl?: string;
  signal?: AbortSignal;
  /** Hard cap on output tokens. When omitted, pi-ai uses roughly 1/3 of
   *  the model's context window. */
  maxTokens?: number;
  /** When set, asks the provider to "think before answering". On Anthropic
   *  Claude 4.x models this enables extended thinking; on OpenAI/Gemini it
   *  maps to their reasoning effort. Older/non-reasoning models ignore it. */
  reasoning?: ReasoningLevel;
  /** v3 wire override — when set, a synthetic PiModel is constructed so
   *  custom endpoints (DeepSeek, Ollama, LiteLLM, Azure, …) route through
   *  the correct pi-ai adapter even if the provider id isn't in pi-ai's
   *  registry. */
  wire?: WireApi;
  /** Extra HTTP headers (merged last). Supports Codex-style static headers
   *  for gateways that require custom auth keys. */
  httpHeaders?: Record<string, string>;
  userImages?: Array<{ data: string; mimeType: string }>;
  /**
   * Allow OpenAI-compatible keyless gateways. The upstream SDK still requires
   * a non-empty apiKey string to instantiate its client, so this uses a local
   * placeholder while auth is supplied by `httpHeaders` or by the gateway.
   */
  allowKeyless?: boolean;
}

export interface GenerateResult {
  content: string;