---
title: "Update collection settings"
method: PATCH
path: "/ai/collections/{uuid}/settings"
tags: ["AI Collections"]
---

# Update collection settings

`PATCH /ai/collections/{uuid}/settings`

Partially updates the collection's retrieval settings.

## Path parameters

- `uuid` string, uuid, required

## Request body

- SettingsRequest
  - `retrieval` RetrievalSettings — How documents are retrieved when searching the collection.
    - `top_k` integer — Number of top results to retrieve (1–50).
    - `retrieval_type` 'vector' | 'hybrid' — Retrieval strategy. `vector` runs semantic similarity search; `hybrid` combines vector similarity with keyword matching; `keyword` runs lexical (BM25) matching. `keyword` is not accepted yet: setting it returns 422 `unsupported_retrieval_type`. A collection set to `hybrid` is accepted here but cannot be searched until hybrid execution ships.

## Response `200`

The updated settings.

- SettingsEnvelope
  - `data` RetrievalSettingsWrapper
    - `record_type` string — Identifies the record type. Always `ai_collection_settings`.
    - `retrieval` RetrievalSettings — How documents are retrieved when searching the collection.
      - `top_k` integer — Number of top results to retrieve (1–50).
      - `retrieval_type` 'vector' | 'hybrid' — Retrieval strategy. `vector` runs semantic similarity search; `hybrid` combines vector similarity with keyword matching; `keyword` runs lexical (BM25) matching. `keyword` is not accepted yet: setting it returns 422 `unsupported_retrieval_type`. A collection set to `hybrid` is accepted here but cannot be searched until hybrid execution ships.

## Other responses

- `400` — The request was malformed or failed validation.
- `401` — Missing or invalid authentication.
- `404` — The requested resource does not exist.
- `422` — Validation error -- unsupported `retrieval_type` (`unsupported_retrieval_type`) or `top_k` out of range 1-50 (`invalid_top_k`).

## Changes

> 73 revisions in range; 1 not diffed.

- **2026-09-16** `a6a61a29ecdd` — 5 breaking, 4 warning, 13 info
  - removed the enum value `keyword` of the request property `retrieval/retrieval_type`
  - the `errors/items/code` response's property type changed from `string` to `integer`, and format from no format to `int32` for status `400`
  - the `errors/items/code` response's property type changed from `string` to `integer`, and format from no format to `int32` for status `401`
  - the `errors/items/code` response's property type changed from `string` to `integer`, and format from no format to `int32` for status `404`
  - …18 more
- **2026-08-17** `1571b0380bd7` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/team-telnyx/apis/telnyx-api-2/changes/ai/collections/:uuid/settings/patch.md)

---

[API](https://skmtc.dev/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.dev/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/team-telnyx/apis/telnyx-api-2/revisions/673109139443?raw)