Interface: ModelOption
Defined in: packages/agentos/src/api/model.ts:518
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?
optionalapiKey:string
Defined in: packages/agentos/src/api/model.ts:537
API key override (takes precedence over environment variables).
baseUrl?
optionalbaseUrl:string
Defined in: packages/agentos/src/api/model.ts:545
Base URL override (useful for local proxies or Ollama). An empty or
whitespace-only value is unset: the global default's URL, then the
provider's base-URL variable, apply as with no baseUrl, and with none the
call goes to the provider's own endpoint. It is never refused as a base URL
meant for another provider, since it names no endpoint.
model?
optionalmodel:string
Defined in: packages/agentos/src/api/model.ts:535
Explicit model identifier. Accepted in two formats:
"provider:model"(e.g."openai:gpt-4o"), split only when the prefix is a provider id agentos knows; the prefix then wins overprovider. Underprovider: 'ollama'an id is never split (Ollama tags carry colons:"qwen2.5:7b"), and an id whose prefix is not a provider ("meta-llama/llama-3.3-70b-instruct:free") is kept whole."model"— plain name (e.g."gpt-4o-mini"). Requiresprovideror env-var auto-detect.
provider?
optionalprovider:string
Defined in: packages/agentos/src/api/model.ts:525
Provider name. When set without model, the default model for the
requested task is looked up in PROVIDER_DEFAULTS.
Example
`"openai"`, `"anthropic"`, `"ollama"`