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

# Replace collection settings

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

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.
    - `retrieval_type` 'vector' | 'hybrid' | 'keyword' — Retrieval strategy. `vector` runs semantic similarity search; `hybrid` combines vector similarity with keyword matching; `keyword` runs lexical (BM25) matching.
    - `top_k` integer — Number of top results to retrieve (1–50).

## 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.
      - `retrieval_type` 'vector' | 'hybrid' | 'keyword' — Retrieval strategy. `vector` runs semantic similarity search; `hybrid` combines vector similarity with keyword matching; `keyword` runs lexical (BM25) matching.
      - `top_k` integer — Number of top results to retrieve (1–50).

## 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`).

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api-2.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api-2/revisions/3fdc16374d70/schema)