omni-settings

<!-- generated by src/lib/agentSkills/generator.ts; manual edits will be overwritten -->

## Overview

Read and update global application settings: system prompts, thinking budget, IP filters, payload rules, combo defaults, and require-login configuration.

## Authentication

All requests require a valid Bearer token or session cookie. Obtain a token via `POST /api/auth/login` or configure `REQUIRE_API_KEY=false` for local development.

## Endpoints

### GET /api/settings

Get application settings

```bash
curl https://localhost:20128/api/settings \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
```

### PATCH /api/settings

Update settings

```bash
curl -X PATCH https://localhost:20128/api/settings \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
  -H "Content-Type: application/json" \
  -d '{}'
```

### GET /api/settings/compression

Get global compression settings

```bash
curl https://localhost:20128/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
```

### PUT /api/settings/compression

Update global compression settings

```bash
curl -X PUT https://localhost:20128/api/settings/compression \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
  -H "Content-Type: application/json" \
  -d '{}'
```

### GET /api/settings/payload-rules

Get payload rules configuration

Returns the current payload rules used to mutate outgoing request payloads before they
are sent upstream.

Requires a dashboard management session cookie when management auth is enabled.


```bash
curl https://localhost:20128/api/settings/payload-rules \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
```

### PUT /api/settings/payload-rules

Update payload rules configuration

Persists and hot reloads payload rules. The legacy input field `default-raw` is accepted
on writes and normalized to `defaultRaw` in responses/runtime state.

Requires a dashboard management session cookie when management auth is enabled.


```bash
curl -X PUT https://localhost:20128/api/settings/payload-rules \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
  -H "Content-Type: application/json" \
  -d '{}'
```

### GET /api/settings/combo-defaults

Get combo default settings

```bash
curl https://localhost:20128/api/settings/combo-defaults \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
```

### GET /api/settings/proxy

Get proxy settings

```bash
curl https://localhost:20128/api/settings/proxy \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
```

### PATCH /api/settings/proxy

Update proxy settings

```bash
curl -X PATCH https://localhost:20128/api/settings/proxy \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
  -H "Content-Type: application/json" \
  -d '{}'
```

### POST /api/settings/proxy/test

Test proxy connection

```bash
curl -X POST https://localhost:20128/api/settings/proxy/test \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
  -H "Content-Type: application/json" \
  -d '{}'
```

### POST /api/settings/require-login

Toggle login requirement

```bash
curl -X POST https://localhost:20128/api/settings/require-login \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
  -H "Content-Type: application/json" \
  -d '{}'
```

### GET /api/settings/ip-filter

Get IP filter configuration

Returns the current IP filter settings including blacklist, whitelist, and temp bans.

```bash
curl https://localhost:20128/api/settings/ip-filter \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
```

### PUT /api/settings/ip-filter

Update IP filter configuration

Configure IP filtering with blacklist/whitelist modes, add/remove individual IPs, and manage temp bans.


```bash
curl -X PUT https://localhost:20128/api/settings/ip-filter \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
  -H "Content-Type: application/json" \
  -d '{}'
```

### GET /api/settings/system-prompt

Get system prompt configuration

Returns the current system prompt injection settings.

```bash
curl https://localhost:20128/api/settings/system-prompt \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
```

### PUT /api/settings/system-prompt

Update system prompt configuration

```bash
curl -X PUT https://localhost:20128/api/settings/system-prompt \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
  -H "Content-Type: application/json" \
  -d '{}'
```

### GET /api/settings/thinking-budget

Get thinking budget configuration

Returns the current thinking/reasoning budget settings for AI models.

```bash
curl https://localhost:20128/api/settings/thinking-budget \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
```

### PUT /api/settings/thinking-budget

Update thinking budget configuration

```bash
curl -X PUT https://localhost:20128/api/settings/thinking-budget \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
  -H "Content-Type: application/json" \
  -d '{}'
```

### GET /api/tags

List Ollama-compatible model tags

Returns models in Ollama /api/tags format for Ollama client compatibility

```bash
curl https://localhost:20128/api/tags \
  -H "Authorization: Bearer $OMNIROUTE_TOKEN"
```

## Payloads

See the full OpenAPI specification at `GET /api/openapi/spec` or `docs/reference/openapi.yaml` for detailed request/response schemas.