mirror of
https://github.com/openclaw/openclaw.git
synced 2026-06-01 03:03:27 +00:00
* fix(nvidia): load featured model catalog Co-authored-by: CaptainTimon <CaptainTimon@users.noreply.github.com> * fix(nvidia): widen catalog fetch timeout * fix(nvidia): cover catalog registration * fix(picker): include provider catalog loader * fix(nvidia): guard featured catalog fetch * fix(nvidia): sync bundled catalog with live API Replace minimaxai/minimax-m2.5 (MiniMax M2.5) with minimaxai/minimax-m2.7 (Minimax M2.7) and z-ai/glm5 (GLM-5) with z-ai/glm-5.1 (GLM 5.1) in the bundled fallback catalog to match NVIDIA's public featured-models endpoint. Update docs table and all extension test expectations. * fix(nvidia): retain shipped catalog refs * fix(picker): keep alias catalog rows * fix(nvidia): restore live catalog priority --------- Co-authored-by: CaptainTimon <CaptainTimon@users.noreply.github.com>
159 lines
5.4 KiB
Markdown
159 lines
5.4 KiB
Markdown
---
|
|
summary: "Use NVIDIA's OpenAI-compatible API in OpenClaw"
|
|
read_when:
|
|
- You want to use open models in OpenClaw for free
|
|
- You need NVIDIA_API_KEY setup
|
|
title: "NVIDIA"
|
|
---
|
|
|
|
NVIDIA provides an OpenAI-compatible API at `https://integrate.api.nvidia.com/v1` for
|
|
open models for free. Authenticate with an API key from
|
|
[build.nvidia.com](https://build.nvidia.com/settings/api-keys).
|
|
|
|
## Getting started
|
|
|
|
<Steps>
|
|
<Step title="Get your API key">
|
|
Create an API key at [build.nvidia.com](https://build.nvidia.com/settings/api-keys).
|
|
</Step>
|
|
<Step title="Export the key and run onboarding">
|
|
```bash
|
|
export NVIDIA_API_KEY="nvapi-..."
|
|
openclaw onboard --auth-choice nvidia-api-key
|
|
```
|
|
</Step>
|
|
<Step title="Set an NVIDIA model">
|
|
```bash
|
|
openclaw models set nvidia/nvidia/nemotron-3-super-120b-a12b
|
|
```
|
|
</Step>
|
|
</Steps>
|
|
|
|
<Warning>
|
|
If you pass `--nvidia-api-key` instead of the env var, the value lands in shell
|
|
history and `ps` output. Prefer the `NVIDIA_API_KEY` environment variable when
|
|
possible.
|
|
</Warning>
|
|
|
|
For non-interactive setup, you can also pass the key directly:
|
|
|
|
```bash
|
|
openclaw onboard --auth-choice nvidia-api-key --nvidia-api-key "nvapi-..."
|
|
```
|
|
|
|
## Config example
|
|
|
|
```json5
|
|
{
|
|
env: { NVIDIA_API_KEY: "nvapi-..." },
|
|
models: {
|
|
providers: {
|
|
nvidia: {
|
|
baseUrl: "https://integrate.api.nvidia.com/v1",
|
|
api: "openai-completions",
|
|
},
|
|
},
|
|
},
|
|
agents: {
|
|
defaults: {
|
|
model: { primary: "nvidia/nvidia/nemotron-3-super-120b-a12b" },
|
|
},
|
|
},
|
|
}
|
|
```
|
|
|
|
## Featured catalog
|
|
|
|
When an NVIDIA API key is configured, OpenClaw setup and model-selection paths
|
|
try NVIDIA's public featured-model catalog from
|
|
`https://assets.ngc.nvidia.com/products/api-catalog/featured-models.json` and
|
|
caches the ranked result for 24 hours. New featured models from build.nvidia.com
|
|
therefore appear in setup and model-selection surfaces without waiting for an
|
|
OpenClaw release.
|
|
|
|
The fetch uses a fixed HTTPS host policy for `assets.ngc.nvidia.com`. If no
|
|
NVIDIA API key is configured, or if that public catalog is unavailable or
|
|
malformed, OpenClaw falls back to the bundled catalog below.
|
|
|
|
## Bundled fallback catalog
|
|
|
|
| Model ref | Name | Context | Max output | Notes |
|
|
| ------------------------------------------ | ---------------------------- | ------- | ---------- | --------------------------------- |
|
|
| `nvidia/nvidia/nemotron-3-super-120b-a12b` | NVIDIA Nemotron 3 Super 120B | 262,144 | 8,192 | Featured fallback |
|
|
| `nvidia/moonshotai/kimi-k2.5` | Kimi K2.5 | 262,144 | 8,192 | Featured fallback |
|
|
| `nvidia/minimaxai/minimax-m2.7` | Minimax M2.7 | 196,608 | 8,192 | Featured fallback |
|
|
| `nvidia/z-ai/glm-5.1` | GLM 5.1 | 202,752 | 8,192 | Featured fallback |
|
|
| `nvidia/minimaxai/minimax-m2.5` | MiniMax M2.5 | 196,608 | 8,192 | Deprecated, upgrade compatibility |
|
|
| `nvidia/z-ai/glm5` | GLM-5 | 202,752 | 8,192 | Deprecated, upgrade compatibility |
|
|
|
|
## Advanced configuration
|
|
|
|
<AccordionGroup>
|
|
<Accordion title="Auto-enable behavior">
|
|
The provider auto-enables when the `NVIDIA_API_KEY` environment variable is set.
|
|
No explicit provider config is required beyond the key.
|
|
</Accordion>
|
|
|
|
<Accordion title="Catalog and pricing">
|
|
OpenClaw prefers NVIDIA's public featured-model catalog when NVIDIA auth is
|
|
configured and caches it for 24 hours. The bundled fallback catalog is static
|
|
and keeps deprecated shipped refs for upgrade compatibility. Costs default to
|
|
`0` in source since NVIDIA currently offers free API access for the listed
|
|
models.
|
|
</Accordion>
|
|
|
|
<Accordion title="OpenAI-compatible endpoint">
|
|
NVIDIA uses the standard `/v1` completions endpoint. Any OpenAI-compatible
|
|
tooling should work out of the box with the NVIDIA base URL.
|
|
</Accordion>
|
|
|
|
<Accordion title="Slow custom provider responses">
|
|
Some NVIDIA-hosted custom models can take longer than the default model idle
|
|
watchdog before they emit a first response chunk. For custom NVIDIA provider
|
|
entries, raise the provider timeout instead of raising the whole agent
|
|
runtime timeout:
|
|
|
|
```json5
|
|
{
|
|
models: {
|
|
providers: {
|
|
"custom-integrate-api-nvidia-com": {
|
|
baseUrl: "https://integrate.api.nvidia.com/v1",
|
|
api: "openai-completions",
|
|
apiKey: "NVIDIA_API_KEY",
|
|
timeoutSeconds: 300,
|
|
},
|
|
},
|
|
},
|
|
agents: {
|
|
defaults: {
|
|
models: {
|
|
"custom-integrate-api-nvidia-com/meta/llama-3.1-70b-instruct": {
|
|
params: { thinking: "off" },
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
```
|
|
|
|
</Accordion>
|
|
</AccordionGroup>
|
|
|
|
<Tip>
|
|
NVIDIA models are currently free to use. Check
|
|
[build.nvidia.com](https://build.nvidia.com/) for the latest availability and
|
|
rate-limit details.
|
|
</Tip>
|
|
|
|
## Related
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Model selection" href="/concepts/model-providers" icon="layers">
|
|
Choosing providers, model refs, and failover behavior.
|
|
</Card>
|
|
<Card title="Configuration reference" href="/gateway/configuration-reference" icon="gear">
|
|
Full config reference for agents, models, and providers.
|
|
</Card>
|
|
</CardGroup>
|