TEteam-telnyx
AI Collections

Create a collection

Changed on

Creates a new collection scoped to your organization. Optionally attach sources and retrieval settings at creation time. If slug is omitted, one is derived from name and must be unique within your organization.

post/ai/collections

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/ai/collections
  • Auth
    HTTP bearer

Request body

namestring required

Human-readable collection name.

descriptionstring

Optional description.

slugstring

Optional slug (unique per organization). Derived from name when omitted.

Example request

{
  "name": "Support Transcripts",
  "description": "All customer support voice transcripts.",
  "slug": "support-transcripts",
  "sources": [
    {
      "source_type": "voice",
      "bucket_id": "policy-docs"
    }
  ],
  "settings": {
    "record_type": "ai_collection_settings",
    "retrieval": {
      "top_k": 5,
      "retrieval_type": "vector"
    }
  }
}

Response

Collection created.

Example response

{
  "data": {
    "uuid": "6a09ccbd-8f9b-4c3a-9b0e-2f1d3c4b5a6e",
    "slug": "support-transcripts",
    "record_type": "ai_collection",
    "name": "Support Transcripts",
    "description": "All customer support voice transcripts.",
    "status": "ready",
    "sources": [
      {
        "id": "source_8vkvtcksnawvbnxq48yv2l06wx",
        "record_type": "ai_collection_source",
        "collection_id": "6a09ccbd-8f9b-4c3a-9b0e-2f1d3c4b5a6e",
        "source_type": "voice",
        "bucket_id": "policy-docs",
        "status": "ready"
      }
    ],
    "settings": {
      "record_type": "ai_collection_settings",
      "retrieval": {
        "top_k": 5,
        "retrieval_type": "vector"
      }
    },
    "created_at": "2026-08-04T12:00:00Z",
    "updated_at": "2026-08-04T12:00:00Z"
  }
}

Changes

  • 67df31283a8aRevision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a72569d69430Revision changes
    • info

      endpoint added