Use NexRouter with Goose

Follow these steps to use your NexRouter key and model in Goose.

Not installed yet? Follow the official guide first, then return here.

1. Get three things readyCopy Anchor Link

• API address: open this site’s connection settings and copy the address required below.
• API key: create or copy a key in API key management. Do not use your login password.
• Model ID: copy the exact ID from the model list, not its display name.

Use an address and key from the same site. Domestic and overseas credentials are separate.

2. Configure GooseCopy Anchor Link

Replace these values in the example; do not leave YOUR_... unchanged:

Create ~/.config/goose/custom_providers/nexrouter.json (Windows: %APPDATA%\Block\goose\config\custom_providers\nexrouter.json):

{
  "name": "nexrouter",
  "engine": "openai",
  "display_name": "NexRouter",
  "description": "NexRouter OpenAI-compatible endpoint",
  "api_key_env": "NEXROUTER_API_KEY",
  "base_url": "YOUR_API_BASE_URL/chat/completions",
  "models": [
    {
      "name": "YOUR_MODEL_ID"
    }
  ],
  "supports_streaming": true,
  "requires_auth": true
}

base_url must be the full /v1/chat/completions endpoint. Set the key and launch from the same terminal:

export NEXROUTER_API_KEY='YOUR_API_KEY'
goose session --provider nexrouter --model YOUR_MODEL_ID

3. Send a test messageCopy Anchor Link

Select the model you just configured, open a new chat, and send:

Please reply with only: Connected

A normal reply means your first connection worked. You can now start your own task.

If no reply arrives, check the error:

• 401 / API key error: copy the full key again and check that the address and key belong to the same site.
• 404 / endpoint not found: compare the URL with the format above, especially missing or repeated /v1.
• Model not found: copy the exact model ID again and check that your key has access.

See Troubleshooting for other errors. To check the API separately, use the first request example.

Learn moreCopy Anchor Link

For installation, complete settings, and advanced features, see the official Goose documentation.