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

# Update a collection

`PATCH /ai/collections/{uuid}`

## Request

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

Updates a collection's metadata (`name` and/or `description`). Sources and settings are managed through their own sub-resources.

## Path parameters

- `uuid` string, uuid, required

## Request body

- UpdateCollectionRequest: Metadata-only update. Provide either or both fields.
  - `name` string
  - `description` string

## Response `200`

The updated collection.

- CollectionEnvelope
  - `data` Collection
    - `uuid` string, uuid
    - `slug` string
    - `record_type` string: Identifies the record type. Always `ai_collection`.
    - `name` string
    - `description` string
    - `status` string
    - `sources` CollectionsSource[]
      - `id` string
      - `record_type` string: Identifies the record type. Always `ai_collection_source`.
      - `collection_id` string, uuid
      - `source_type` 'voice' | 'meeting_bot' | 'message' | 'bucket': The type of Telnyx data attached as a source. `bucket` requires an additional `bucket_id`. Only `voice` is searchable today; `meeting_bot`, `message`, and `bucket` attach but are not yet searchable (Coming soon).
      - `bucket_id` string: The Telnyx Storage bucket name. Present only for `bucket` sources.
      - `status` string
    - `settings` 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.
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Other responses

- `400`: The request was malformed or failed validation.
- `401`: Missing or invalid authentication.
- `404`: The requested resource does not exist.

## Changes

- **2026-10-21** `67df31283a8a`: 3 breaking, 3 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`
  - added the optional property `errors/items/description` to the response with the `400` status
  - …2 more
- **2026-10-15** `a72569d69430`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/team-telnyx/apis/telnyx-api/changes/ai/collections/:uuid/patch.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)