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

# Replace collection settings

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

## Request

- Base URL: `https://api.telnyx.com/v2`
- URL: `https://api.telnyx.com/v2/ai/collections/{uuid}/settings`
- Auth: HTTP bearer

Replaces 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

- **2026-10-21** `67df31283a8a`: 4 breaking, 4 info
  - the `errors/items/code` response's property type changed from `integer` to `string`, and format from `int32` to no format for status `400`
  - the `errors/items/code` response's property type changed from `integer` to `string`, and format from `int32` to no format for status `401`
  - the `errors/items/code` response's property type changed from `integer` to `string`, and format from `int32` to no format for status `404`
  - the `errors/items/code` response's property type changed from `integer` to `string`, and format from `int32` to no format for status `422`
  - …4 more
- **2026-10-15** `a72569d69430`: 1 info
  - endpoint added

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

---

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