Skip to main content

Interface: ModelOption

Defined in: packages/agentos/src/api/model.ts:245

Flexible model option accepted by the high-level API functions.

At least one of provider or model must be supplied, or an appropriate API key environment variable must be set for auto-detection.

Properties​

apiKey?​

optional apiKey: string

Defined in: packages/agentos/src/api/model.ts:260

API key override (takes precedence over environment variables).

baseUrl?​

optional baseUrl: string

Defined in: packages/agentos/src/api/model.ts:262

Base URL override (useful for local proxies or Ollama).

model?​

optional model: string

Defined in: packages/agentos/src/api/model.ts:258

Explicit model identifier. Accepted in two formats:

  • "provider:model" — legacy format (e.g. "openai:gpt-4o"). provider is ignored.
  • "model" — plain name (e.g. "gpt-4o-mini"). Requires provider or env-var auto-detect.

provider?​

optional provider: string

Defined in: packages/agentos/src/api/model.ts:252

Provider name. When set without model, the default model for the requested task is looked up in PROVIDER_DEFAULTS.

Example​

`"openai"`, `"anthropic"`, `"ollama"`