Source: https://ailoot.ai/docs/integrations/plandex/
Canonical: https://ailoot.ai/docs/en/integrations/plandex/
Language: en

[Terminal agents](https://ailoot.ai/docs/en/integrations/#agents) 

# Plandex

[Markdown](https://ailoot.ai/docs/en/integrations/plandex/index.md)

Terminal agent · OpenAI Chat

| Format | Where to set it up |
| --- | --- |
| OpenAI Chat | plandex models custom, or \\models custom in the REPL, opens the JSON file for custom models and providers |

## [](https://ailoot.ai/docs/integrations/plandex/#setup)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, then use that ID in the configuration. For agents, also check tool support and the features required by your client version.

```json
{
  "$schema": "https://plandex.ai/schemas/models-input.schema.json",
  "providers": [
    {
      "name": "ailoot",
      "baseUrl": "https://api.ailoot.ai/v1",
      "apiKeyEnvVar": "AILOOT_API_KEY"
    }
  ],
  "models": [
    {
      "modelId": "ailoot-claude-sonnet-5-5",
      "publisher": "anthropic",
      "description": "Claude Sonnet 5.5 via Ailoot",
      "defaultMaxConvoTokens": 75000,
      "maxTokens": 1000000,
      "maxOutputTokens": 64000,
      "reservedOutputTokens": 32000,
      "preferredOutputFormat": "xml",
      "providers": [
        {
          "provider": "custom",
          "customProvider": "ailoot",
          "modelName": "claude-sonnet-5-5"
        }
      ]
    }
  ]
}
```

This configuration reads the key from the environment variable `AILOOT_API_KEY`. Set it before starting the application:

```bash
export AILOOT_API_KEY="sk-..."   # add to ~/.zshrc or ~/.bashrc
```

```powershell
setx AILOOT_API_KEY "sk-..."   # then restart the terminal
```

Example model: `claude-sonnet-5-5`. Choose any other model from the [catalog](https://ailoot.ai/models/en/) — check that it supports the format you need.

## [](https://ailoot.ai/docs/integrations/plandex/#notes)Good to know

Custom providers work only in self-hosted Plandex. In the cloud, BYO keys are limited to built-in providers. All custom providers must be OpenAI-compatible (Chat Completions). Then add the model to a custom model pack.

## [](https://ailoot.ai/docs/integrations/plandex/#check)Test

- For the OpenAI format, the URL is `https://api.ailoot.ai/v1` (or the full path if the application asks for a full URL).
- Ask a short question. If you get an error, check the code and Request ID, then consult [Errors and limits](https://ailoot.ai/docs/en/errors/).
- 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](https://ailoot.ai/docs/en/billing/reserve/).

Application documentation: [https://github.com/plandex-ai/plandex/blob/main/docs/docs/models/custom-models.md](https://github.com/plandex-ai/plandex/blob/main/docs/docs/models/custom-models.md)

Still have questions? Send your Request ID and a description — we'll help you troubleshoot.[Contact support](mailto:support@ailoot.ai)

## Ailoot · The company and its project portfolio





Ailoot combines established operating experience, a large client base, stable service and ongoing KPI control.





The company and its project portfolio: millions of customers; monthly sales in the billions.





Ailoot brings that operating experience to API access for AI features in customer products, agents, applications and automations.