Configuration
API Keys
Connect model providers, Codex, Copilot, and remote auth profiles.
xCloud uses OpenClaw for model providers. Some providers use API keys. Others use a login profile.
The most important distinction: an OpenAI API key and an OpenAI Codex login are not the same thing.
Provider Types
| Provider type | Example | How it authenticates |
|---|---|---|
| API key provider | Anthropic, OpenAI API, Google, Groq | Paste an API key |
| Account login provider | OpenAI Codex, GitHub Copilot | Browser/login flow |
| Local provider | Ollama | Local server, usually no key |
| Remote engine provider | Any of the above | Stored on the active engine |
OpenAI API vs OpenAI Codex
| Option | Use when | Notes |
|---|---|---|
| OpenAI API | You have an OpenAI platform API key | Billed through API usage |
| OpenAI Codex | You want to use your Codex/ChatGPT account access | Uses an auth profile, not the API key field |
If a user connects OpenAI API, they should select OpenAI API models. If they connect OpenAI Codex, they should select OpenAI Codex models.
Add An API Key
- Go to Settings > API Keys.
- Select the provider.
- Paste the key.
- Save.
- Go to Settings > Models and choose a model from that provider.
Keys are written into the OpenClaw config for the active engine.
Remote Engines
When using a PC or VPS engine, keys and auth profiles need to be available to that engine.
That means:
- A key saved while Local is active belongs to Local.
- A key saved while VPS is active belongs to the VPS engine.
- Switching engines changes which keys and auth profiles are visible.
Verify A Provider
After saving credentials:
- Open Settings > Models.
- Search for the provider.
- Select a model.
- Send a short test message.
If the request fails, check the active engine, key value, provider balance, and model name.
Common Problems
| Problem | Cause | Fix |
|---|---|---|
| Model appears but fails | Key is missing or invalid on the active engine | Save the key again while that engine is active |
| Codex does not use OpenAI API key | Codex uses account auth, not API key auth | Use the OpenAI Codex login flow |
| Works locally but not on VPS | Credentials were saved only locally | Save credentials while VPS is active |
| Provider says unauthorized | Wrong key, expired key, or wrong provider selected | Re-create the key and select the matching model provider |