> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/backend-api/resources/commons/user/settings/ui.md).

# User UI settings

The user interface settings intended for storing settings of client applications that use the API.\
One can imagine that this works similarly to the browser cache/local storage mechanism. The feature is that long-term\
storage of these settings provided but not guaranteed - when the quota exceeded, data could be deleted.

## API actions

API path: `/user/settings/ui`.

### read

Reads setting value by key.

#### Parameters

| name | description                                                                                                | type   |
| ---- | ---------------------------------------------------------------------------------------------------------- | ------ |
| key  | Length should be between 1 and 50 is 50 symbols, should only contain English letters, digits, `_` and `-`. | string |

#### Examples

cURL

```sh
curl -X POST 'https://api.eu.navixy.com/v2/user/settings/ui/read' \
    -H 'Content-Type: application/json' \
    -d '{"hash": "22eac1c27af4be7b9d04da2ce1af111b", "key": "tracker-icons"}'
```

#### Responses:

```json
{
  "success": true,
  "value": "previously saved value"
}
```

When nonexistent key provided:

```json
{
  "success": false,
  "status": {
    "code": 201,
    "description": "Not found in database"
  }
}
```

#### Errors

* [General](/docs/navixy-api/user-api/backend-api/errors.md#error-codes) types only.

### update

Sets setting value.

#### Parameters

| name  | description                                                                                                | type   |
| ----- | ---------------------------------------------------------------------------------------------------------- | ------ |
| key   | Length should be between 1 and 50 is 50 symbols, should only contain English letters, digits, `_` and `-`. | string |
| value | A new UI config value. Length should be between 0 and 8192 symbols.                                        | string |

#### Responses:

```json
{
  "success": true
}
```

#### Errors

* [General](/docs/navixy-api/user-api/backend-api/errors.md#error-codes) types.
* 268 - over quota. The amount of storage available for the user for these settings has been exhausted. New settings\
  cannot be added until the amount of stored data has been reduced.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-api/user-api/backend-api/resources/commons/user/settings/ui.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.