> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/open-webui/open-webui/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration

> Evaluation arena configuration endpoints

## Get Evaluation Configuration

<api method="GET" endpoint="/api/evaluations/config" />

Retrieve the current evaluation arena configuration. Admin only.

The evaluation arena allows users to compare models side-by-side and provide feedback on which performs better for specific tasks.

### Response

<ResponseField name="ENABLE_EVALUATION_ARENA_MODELS" type="boolean">
  Whether the evaluation arena feature is enabled
</ResponseField>

<ResponseField name="EVALUATION_ARENA_MODELS" type="array">
  Array of model configurations available in the evaluation arena

  <Expandable title="Model configuration properties">
    <ResponseField name="id" type="string">
      Unique model identifier
    </ResponseField>

    <ResponseField name="name" type="string">
      Display name for the model
    </ResponseField>

    <ResponseField name="info" type="object" optional>
      Additional model information and metadata
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://your-instance.com/api/evaluations/config" \
    -H "Authorization: Bearer $OPENWEBUI_API_KEY"
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      "https://your-instance.com/api/evaluations/config",
      headers={"Authorization": f"Bearer {api_key}"}
  )
  config = response.json()
  print(f"Arena enabled: {config['ENABLE_EVALUATION_ARENA_MODELS']}")
  print(f"Available models: {len(config['EVALUATION_ARENA_MODELS'])}")
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "ENABLE_EVALUATION_ARENA_MODELS": true,
    "EVALUATION_ARENA_MODELS": [
      {
        "id": "gpt-4",
        "name": "GPT-4",
        "info": {
          "provider": "openai",
          "capabilities": ["chat", "code"]
        }
      },
      {
        "id": "claude-3",
        "name": "Claude 3",
        "info": {
          "provider": "anthropic",
          "capabilities": ["chat", "analysis"]
        }
      },
      {
        "id": "llama-3",
        "name": "Llama 3",
        "info": {
          "provider": "meta",
          "capabilities": ["chat"]
        }
      }
    ]
  }
  ```
</ResponseExample>

***

## Update Evaluation Configuration

<api method="POST" endpoint="/api/evaluations/config" />

Update the evaluation arena configuration. Admin only.

Use this endpoint to enable/disable the arena feature or modify the list of models available for comparison.

### Request Body

<ParamField body="ENABLE_EVALUATION_ARENA_MODELS" type="boolean" optional>
  Enable or disable the evaluation arena feature
</ParamField>

<ParamField body="EVALUATION_ARENA_MODELS" type="array" optional>
  Array of model configurations to make available in the arena

  <Expandable title="Model configuration properties">
    <ParamField body="id" type="string" required>
      Unique model identifier (must match an existing model ID in your system)
    </ParamField>

    <ParamField body="name" type="string" required>
      Display name for the model
    </ParamField>

    <ParamField body="info" type="object" optional>
      Additional model information and metadata
    </ParamField>
  </Expandable>
</ParamField>

### Response

Returns the updated configuration with the same structure as the GET endpoint.

<RequestExample>
  ```bash cURL - Enable Arena theme={null}
  curl -X POST "https://your-instance.com/api/evaluations/config" \
    -H "Authorization: Bearer $OPENWEBUI_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "ENABLE_EVALUATION_ARENA_MODELS": true
    }'
  ```

  ```bash cURL - Update Models theme={null}
  curl -X POST "https://your-instance.com/api/evaluations/config" \
    -H "Authorization: Bearer $OPENWEBUI_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "EVALUATION_ARENA_MODELS": [
        {
          "id": "gpt-4",
          "name": "GPT-4",
          "info": {"provider": "openai"}
        },
        {
          "id": "claude-3-opus",
          "name": "Claude 3 Opus",
          "info": {"provider": "anthropic"}
        }
      ]
    }'
  ```

  ```python Python theme={null}
  import requests

  # Enable arena and configure models
  response = requests.post(
      "https://your-instance.com/api/evaluations/config",
      headers={"Authorization": f"Bearer {api_key}"},
      json={
          "ENABLE_EVALUATION_ARENA_MODELS": True,
          "EVALUATION_ARENA_MODELS": [
              {
                  "id": "gpt-4",
                  "name": "GPT-4",
                  "info": {"provider": "openai", "version": "latest"}
              },
              {
                  "id": "claude-3-opus",
                  "name": "Claude 3 Opus",
                  "info": {"provider": "anthropic", "version": "latest"}
              },
              {
                  "id": "llama-3-70b",
                  "name": "Llama 3 70B",
                  "info": {"provider": "meta", "parameters": "70B"}
              }
          ]
      }
  )
  updated_config = response.json()
  print(f"Arena enabled: {updated_config['ENABLE_EVALUATION_ARENA_MODELS']}")
  print(f"Configured {len(updated_config['EVALUATION_ARENA_MODELS'])} models")
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "ENABLE_EVALUATION_ARENA_MODELS": true,
    "EVALUATION_ARENA_MODELS": [
      {
        "id": "gpt-4",
        "name": "GPT-4",
        "info": {"provider": "openai", "version": "latest"}
      },
      {
        "id": "claude-3-opus",
        "name": "Claude 3 Opus",
        "info": {"provider": "anthropic", "version": "latest"}
      },
      {
        "id": "llama-3-70b",
        "name": "Llama 3 70B",
        "info": {"provider": "meta", "parameters": "70B"}
      }
    ]
  }
  ```
</ResponseExample>

## Configuration Notes

### Arena Feature

The evaluation arena enables users to:

* Compare multiple models side-by-side on the same prompt
* Rate which model performed better (creating feedback entries)
* Tag evaluations with topic keywords (e.g., "coding", "creative writing")
* Contribute to the overall leaderboard rankings

### Model Selection

When configuring `EVALUATION_ARENA_MODELS`:

* Model IDs must correspond to models available in your Open WebUI instance
* Include a diverse set of models to enable meaningful comparisons
* Consider organizing models by capability (e.g., general chat, coding, reasoning)
* The `info` object can include any metadata useful for your use case

### Disabling the Arena

To disable the evaluation arena:

```json theme={null}
{
  "ENABLE_EVALUATION_ARENA_MODELS": false
}
```

This will hide the arena UI while preserving existing feedback data.