---
title: "Update User Settings"
method: PATCH
path: "/api/user/settings"
tags: ["user"]
---

# Update User Settings

`PATCH /api/user/settings`

Update user's settings (merge with existing).

## Request body

- UserSettingsUpdate — User settings update request - allows partial updates.
  - `pinned_workspaces` string[], nullable
  - `active_config` UserActiveConfig — Partial configuration for user active config - all fields optional for overrides.
    - `QueryLLM` QueryLLMConfig
      - `MODEL_NAME` string — The name of the model to be used.
      - `API_TYPE` 'local' | 'remote' — The inference type (local or remote).
      - `SYSTEM_INSTRUCTION` string — The system instruction string.
      - `MAX_CHAR_SIZE_TO_ANSWER` integer — Maximum character size to answer.
      - `TEMPERATURE` number — Temperature value for randomness.
      - `MAX_TOKENS` integer — Maximum number of tokens allowed.
    - `TitleLLM` TitleLLMConfig
      - `MODEL_NAME` string — The name of the model to be used.
      - `API_TYPE` 'local' | 'remote' — API type for the model.
      - `SYSTEM_INSTRUCTION` string
      - `MAX_CHAR_SIZE_TO_ANSWER` integer — Maximum character size to answer.
      - `TEMPERATURE` number — Temperature value for randomness.
      - `MAX_TOKENS` integer — Maximum number of tokens allowed.
    - `DocumentDateExtractorLLM` DocumentDateExtractorLLMConfig
      - `MODEL_NAME` string — The name of the model to be used.
      - `API_TYPE` 'local' | 'remote' — API type for the model.
      - `SYSTEM_INSTRUCTION` string
      - `MAX_CHAR_SIZE_TO_ANSWER` integer — Maximum character size to answer.
      - `TEMPERATURE` number — Temperature value for randomness.
      - `MAX_TOKENS` integer — Maximum number of tokens allowed.
    - `ModelCitation` ModelCitationConfig
      - `SIM_THREASHOLD` number — How similar does the statement needs to be to be considered as citation.
      - `MODEL_NAME` string — Name of the model to be used.
    - `Parser` ParserConfig
    - `Chunker` ChunkerConfig
    - `Embedder` EmbedderConfig
      - `MODEL_NAME` string — The name of the embedder model.
      - `API_TYPE` 'local' | 'remote' — The inference type (local or remote).
    - `Retriever` RetrieverConfig
      - `MIN_RETRIEVAL_SIM_SCORE` number — Minimum similarity score for retrieval of a chunk.
      - `MAX_DISTINCT_DOCUMENTS` integer — Maximum number of distinct documents to search for.
      - `MAX_TOTAL_CHUNKS_TO_RETRIEVE` integer — Maximum total number of chunks to retrieve for all documents retrieved.
      - `GROUP_SIZE` integer — Maximum number of chunks per document for retrieval.
    - `Reranker` RerankerConfig
      - `MAX_NUMB_OF_CHUNKS` integer — Maximum number of chunks to return after reranking.
      - `MODEL_NAME` string — Name of the reranking model to use.
      - `API_TYPE` 'local' | 'remote' — The inference type (local or remote).

## Response `204`

Successful Response

## Other responses

- `422` — Validation Error

## Changes

- **2025-08-06** `43c12480eb1b` — 1 info
  - added the new optional request property `active_config`

[Change history](https://skmtc.dev/arbicity/apis/arbi/changes/api/user/settings/patch.md)

---

[API](https://skmtc.dev/arbicity/apis/arbi.md) · [All operations](https://skmtc.dev/arbicity/apis/arbi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/arbicity/arbi/revisions/43c12480eb1b/schema)