> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Aider setup

> Edit code with Aider using a Pearl model.

## Before you start

Complete organization setup, make sure your account has inference credit, and create a key on the [API Keys page](https://platform.pearlresearch.ai/api-keys). Most coding agents need a tool-capable chat model; Aider's basic edit workflow does not require native tool calling. Image input and reasoning support depend on the model. These terminal examples use Bash or Zsh on macOS, Linux, or Windows through WSL.

Install Aider using its official installation guide and open a terminal in your project. [Installation instructions](https://aider.chat/docs/install.html).

```bash theme={null}
aider --version
```

## Get your connection settings

Open [Integrations](https://platform.pearlresearch.ai/integrations), select a model, then choose Aider. The screen uses your organization's region. The examples below use the public global endpoint; replace it with your regional endpoint and replace `YOUR_MODEL_ID` with the full model ID shown there. Choose one of the models listed for this integration.

Set your Pearl API key in the terminal where you run Aider:

```bash theme={null}
export PEARL_API_KEY="YOUR_PEARL_API_KEY"
```

## Configure Aider

The startup command applies the Pearl endpoint and key to that process. Keep openai/ before the full model ID: it selects LiteLLM's OpenAI-compatible transport, while requests still go to Pearl.

```bash Start Aider in your project theme={null}
OPENAI_API_KEY="$PEARL_API_KEY" \
  OPENAI_API_BASE='https://inference.pearlresearch.ai/v1' \
  aider --model 'openai/YOUR_MODEL_ID'
```

## Start using Aider

Start Aider in your project, add the files you want it to edit, and ask for a small change. Review the resulting diff. Aider uses edit formats rather than requiring native tool calls for this basic workflow.

## Troubleshooting

An unknown-model warning can mean Aider lacks metadata for a custom model, rather than a failed API connection. Check the exact model ID and choose an edit format the model handles well. Leave reasoning\_effort unset; use the server default unless configuring Pearl's native reasoning body explicitly.

* `401`: check the key and allow time for a newly created key to reach the inference gateway.
* `404`: copy the endpoint and exact model ID from Integrations. OpenAI base URLs end in `/v1`; the Anthropic SDK and Claude Code use the URL without that suffix.
* `402`: check your organization's credit and billing status.
* `429` or Anthropic `529`: respect retry instructions and reduce concurrency.
* For truncated output, check the output limit and reasoning budget. Increase limits only within the model's maximum output length.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.