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

# API Configuration

> Set up AI model API keys in SoloEnt

Configure API keys to enable SoloEnt's AI writing features.

## Entry points

### Quick config from chat

<Steps>
  <Step title="Click the model name at the bottom of the chat">
    Click the model name at the bottom of the Agent chat to open the model settings panel.
  </Step>
</Steps>

<img src="https://mintcdn.com/soloent/4RpSHkUFmW5kEqcF/assets/images/apikey_1.png?fit=max&auto=format&n=4RpSHkUFmW5kEqcF&q=85&s=a380930952d0ba22b51d93be0f9a74f3" alt="Quick API configuration from chat" style={{ width: '70%', maxWidth: '400px', display: 'block' }} width="686" height="272" data-path="assets/images/apikey_1.png" />

### Via settings panel

<Steps>
  <Step title="Open Agent settings">
    Click the settings icon in the Agent panel.
  </Step>

  <Step title="Go to model settings">
    Choose whether to use official models directly or configure your own model (BYOK).
  </Step>
</Steps>

<img src="https://mintcdn.com/soloent/4RpSHkUFmW5kEqcF/assets/images/apikey_3.png?fit=max&auto=format&n=4RpSHkUFmW5kEqcF&q=85&s=261ac83f5e7036db95d25d509c2cc432" alt="API configuration via settings panel" style={{ width: '70%', maxWidth: '400px', display: 'block' }} width="812" height="1072" data-path="assets/images/apikey_3.png" />

## Official API

SoloEnt provides an official API. Once logged in, you can use it directly without setting up any third-party keys.

### Free models

Official free models are available immediately after login. The available free models and discounts are updated regularly with ongoing campaigns.

<Note>
  Every registered user gets a trial credit of **\$0.5**; join [platform activities](https://soloent.ai/en/activities) to earn more free credit.
</Note>

<img src="https://mintcdn.com/soloent/4RpSHkUFmW5kEqcF/assets/images/apikey_4.png?fit=max&auto=format&n=4RpSHkUFmW5kEqcF&q=85&s=da746ca341868270d88d79da60e4fd00" alt="Settings panel showing SoloEnt AI as the API provider with Free tab listing available free models" style={{ width: '70%' }} width="720" height="948" data-path="assets/images/apikey_4.png" />

<Warning>
  Free models are for trying out the tool. Response times may be slower or less consistent during periods of high demand.
</Warning>

### Subscription models (VIP)

Lite, Pro, and Max subscribers can use all models in the VIP list — covering the latest models from top providers including Anthropic, OpenAI, Google, and DeepSeek — without configuring any third-party API key.

<Note>
  SoloEnt API pricing matches the official pricing of each model provider, with no additional fees, and different models offer different discounts from time to time.
</Note>

See all official models and the latest discounts at [soloent.ai/en/models](https://soloent.ai/en/models).

***

## Third-party API key configuration

An API key is your authentication credential for accessing AI models — typically a random string:

```
sk-abc123xyz456def789ghi012jkl345mno678pqr901stu234
```

<Warning>
  **Important:** API access is billed separately from monthly subscriptions. A \$20 subscription does not include API usage. For example, a Gemini membership you subscribe to cannot be used as an API here.
</Warning>

### Where to get API keys

#### Popular providers

| Provider        | Latest Models                      | Best For                                            |
| --------------- | ---------------------------------- | --------------------------------------------------- |
| **OpenAI**      | GPT-5.6                            | Writing research, general writing                   |
| **Anthropic**   | Claude Sonnet-5 / Opus-5 / Fable-5 | Story planning, strategic thinking, prose writing   |
| **Google**      | Gemini-3.1-pro                     | Fast, cost-effective, prose writing, multimodal     |
| **xAI**         | Grok-4.5                           | Real-time info, flexible content policy, multimodal |
| **DeepSeek**    | DeepSeek-V4-pro                    | Budget-friendly, flexible content policy            |
| **Zhipu AI**    | GLM-5.2                            | Story planning, Chinese content                     |
| **Moonshot AI** | Kimi-K3                            | Long context, Chinese content                       |
| **OpenRouter**  | Multiple models                    | Unified access, model comparison                    |

<Tip>
  See the [complete API directory](../resources/api-directory) for detailed provider information and registration steps.
</Tip>

<Card title="Get free API keys" icon="gift" href="../resources/free-api-keys">
  Explore free tier options and community resources
</Card>

### Filling in the API details you purchased

#### Standard configuration (official providers)

For OpenAI, Anthropic, Google, and select aggregators — find the corresponding provider in the API Provider dropdown and enter only the API Key:

```plaintext theme={null}
API Key: sk-abc123xyz456...
```

#### OpenAI-compatible configuration (third-party)

Select **OpenAI Compatible** from the API Provider dropdown to configure a third-party provider.

<img src="https://mintcdn.com/soloent/4RpSHkUFmW5kEqcF/assets/images/zh/faq_api_openai.png?fit=max&auto=format&n=4RpSHkUFmW5kEqcF&q=85&s=eb6732c3e8b473cb83128b64173916ce" alt="API Configuration panel with API Provider dropdown expanded, OpenAI Compatible option highlighted" style={{ width: '70%' }} width="934" height="992" data-path="assets/images/zh/faq_api_openai.png" />

Most third-party providers require all three fields:

<ParamField path="base_url" type="string" required>
  API endpoint URL (e.g., `https://api.provider.com/v1`)
</ParamField>

<ParamField path="api_key" type="string" required>
  Your API key
</ParamField>

<ParamField path="model_id" type="string" required>
  Model identifier (e.g., `gpt-4-turbo`)
</ParamField>

<Warning>
  All three fields are required. Confirm with your provider before purchasing.
</Warning>

#### Local LLMs

Run AI models on your own computer for privacy and offline access.

| Solution      | Models                    | Best For                      |
| ------------- | ------------------------- | ----------------------------- |
| **Ollama**    | Llama 3.1, Qwen, DeepSeek | Easy setup, macOS/Linux       |
| **LM Studio** | Multiple open models      | GUI interface, cross-platform |
| **vLLM**      | Custom deployments        | High performance, production  |

<Card title="Local model setup guide" icon="laptop" href="../resources/local-llms">
  Complete guide to running models locally
</Card>

## Using a Codex / Claude Code subscription in SoloEnt

If you already have an OpenAI Codex or Claude Code subscription, you can reuse that subscription's quota directly in SoloEnt while enjoying SoloEnt's professional writing Skills — no need to buy a separate API key.

#### Using a Codex subscription

Select **BYOK**, choose **OpenAI Codex** in the API Provider list, and click to sign in to OpenAI Codex. Once signed in, you can select the models Codex provides (such as GPT-5.x) from the model list. No extra API key is needed when using a ChatGPT Plus or Pro subscription.

<img src="https://mintcdn.com/soloent/4RpSHkUFmW5kEqcF/assets/images/codex.png?fit=max&auto=format&n=4RpSHkUFmW5kEqcF&q=85&s=0ec7f282fa0033e736f5ea351ab60a93" alt="BYOK configuration with API Provider set to OpenAI Codex, showing the Sign in to OpenAI Codex button" style={{ width: '55%' }} width="642" height="1046" data-path="assets/images/codex.png" />

#### Using a Claude Code subscription

First install the **Claude Code CLI** on your computer and bind your Claude Code subscription account, making sure Claude Code runs correctly locally. Then select **BYOK**, choose **Claude Code** from the list, and — with no other setup — pick the Claude model you want directly from the model list.

<img src="https://mintcdn.com/soloent/4RpSHkUFmW5kEqcF/assets/images/claudecode.png?fit=max&auto=format&n=4RpSHkUFmW5kEqcF&q=85&s=cb4ad3d2c3c24fb07806b165fe8997c1" alt="BYOK configuration with API Provider set to Claude Code, showing the Claude Code CLI Path and model selection" style={{ width: '55%' }} width="632" height="980" data-path="assets/images/claudecode.png" />

## Common error codes

| Cause                | Error Code | Error Message                                          |
| -------------------- | :--------: | ------------------------------------------------------ |
| Missing model        |    `400`   | `Missing model`                                        |
| Budget exceeded      |    `403`   | `Budget exceeded`                                      |
| Free quota exhausted |    `403`   | `Daily free quota used up, please try again tomorrow.` |
| Model not found      |    `404`   | `Model not found`                                      |

<Note>
  Other errors caused by instability in third-party models cannot be accurately diagnosed by SoloEnt at this time.
</Note>

## Other FAQ

<AccordionGroup>
  <Accordion title="Invalid API key">
    * Verify you copied the entire key
    * Check if the key has expired
    * Regenerate from the provider dashboard
  </Accordion>

  <Accordion title="Connection fails">
    * Check your internet connection
    * Verify the Base URL (for OpenAI Compatible configuration)
    * Try without a VPN
  </Accordion>
</AccordionGroup>

## Next steps

<CardGroup cols={2}>
  <Card title="Language settings" icon="language" href="./language-settings">
    Set your preferred language
  </Card>

  <Card title="Start writing" icon="pen-to-square" href="../tips/create-project">
    Create your first project
  </Card>

  <Card title="Local models" icon="laptop" href="../resources/local-llms">
    Run AI models on your computer
  </Card>

  <Card title="Free API keys" icon="gift" href="../resources/free-api-keys">
    Get free access to AI models
  </Card>
</CardGroup>
