# Connect goose to Void API

Add Void API as a reusable custom provider in goose CLI or Desktop.

Examples use MODEL_ID as a placeholder, not an available model. Replace it with an ID from the current catalog. Choose a model that supports the endpoint and features used by this tool; vision and tool calling are not universal.

[Current model catalog](https://void-api.tech/models)

## API key

Store your key in an environment variable.

### Environment variables

```
export VOID_API_KEY='void_your_key'
```

## Configuration

Create a custom OpenAI-compatible provider. goose expects the complete chat completions URL.

### ~/.config/goose/custom_providers/void_api.json

```
{
  "name": "void_api",
  "engine": "openai",
  "display_name": "Void API",
  "description": "Void API OpenAI-compatible provider",
  "api_key_env": "VOID_API_KEY",
  "base_url": "https://void-api.tech/v1/chat/completions",
  "models": [
    {
      "name": "MODEL_ID"
    }
  ],
  "supports_streaming": true,
  "requires_auth": true
}
```

## Run

Start a session with the custom provider.

### shell

```
goose session start --provider void_api
```

[Upstream documentation](https://github.com/block/goose/blob/main/documentation/docs/getting-started/providers.md)