docs
Terminal agents

Goose

Markdown

Terminal agent · OpenAI Chat, Anthropic Messages

Full guide
FormatWhere to set it up
OpenAI Chat, Anthropic Messagesgoose configure → Custom Providers → Add A Custom Provider, or JSON in ~/.config/goose/custom_providers/ (Windows: %APPDATA%\Block\goose\config\custom_providers\); alternatively, use the built-in OpenAI provider with OPENAI_HOST/OPENAI_BASE_PATH

Setup

Copy the configuration and replace sk-... with your key from the Ailoot Dashboard. Prefer storing the key in the environment variable AILOOT_API_KEY, if the application supports it.

Before starting, request GET /v1/models with your Ailoot key. Choose an exact model ID whose methods include POST /v1/chat/completions, POST /v1/messages, then use that ID in the configuration. For agents, also check tool support and the features required by your client version.

~/.config/goose/custom_providers/ailoot.json

{
  "name": "ailoot",
  "engine": "openai",
  "display_name": "Ailoot",
  "description": "Ailoot API",
  "api_key_env": "AILOOT_API_KEY",
  "base_url": "https://api.ailoot.ai/v1/chat/completions",
  "models": [
    {
      "name": "claude-sonnet-5-5",
      "context_limit": 1000000
    },
    {
      "name": "gpt-6.1-sol",
      "context_limit": 272000
    }
  ],
  "supports_streaming": true,
  "requires_auth": true
}
export AILOOT_API_KEY="sk-..."
goose session start --provider ailoot

# alternative using the built-in OpenAI provider:
export GOOSE_PROVIDER=openai
export OPENAI_HOST=https://api.ailoot.ai
export OPENAI_BASE_PATH=v1/chat/completions
export OPENAI_API_KEY="$AILOOT_API_KEY"

Example model: claude-sonnet-5-5. Choose any other model from the catalog — check that it supports the format you need.

Good to know

Test

  • For custom base_url or the built-in OPENAI_HOST and OPENAI_BASE_PATH settings, use the corresponding configuration example above. The prefix for OpenAI API methods is https://api.ailoot.ai/v1 (or the full path if the application asks for a full URL).
  • For the Anthropic format, the URL is https://api.ailoot.ai — the API origin. The example above does not show the full setup for this format; consult the client’s documentation for the path to use in the relevant field. The API route prefix is /v1.
  • Ask a short question. If you get an error, check the code and Request ID, then consult Errors and limits.
  • 404 immediately after setup almost always means the URL is wrong: an extra or missing /v1.
  • 402 — insufficient balance for the reserve. Agents reserve more than chat: why.

Application documentation: https://github.com/aaif-goose/goose/blob/main/documentation/docs/getting-started/providers.md

Still have questions? Send your Request ID and a description — we'll help you troubleshoot.Contact support