AI Collections

Add a collection source

Changed on

Attaches a new content source to the specified collection and returns the created source. The source's content is ingested and embedded so it becomes searchable within the collection.

post/ai/collections/{uuid}/sources

Request

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

Path parameters

uuidstring uuid required
Example:6a09ccbd-8f9b-4c3a-9b0e-2f1d3c4b5a6e

The collection's unique identifier.

Request body

source_type'voice' | 'meeting_bot' | 'message' | 'bucket' required

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_idstring

The Telnyx Storage bucket name. Required when source_type is bucket; ignored otherwise.

Example request

{
  "source_type": "voice",
  "bucket_id": "policy-docs"
}

Response

The created source.

Example response

{
  "data": {
    "id": "source_8vkvtcksnawvbnxq48yv2l06wx",
    "record_type": "ai_collection_source",
    "collection_id": "6a09ccbd-8f9b-4c3a-9b0e-2f1d3c4b5a6e",
    "source_type": "voice",
    "bucket_id": "policy-docs",
    "status": "ready"
  }
}

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

    • 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

    • info

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • breaking

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

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from 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

    • info

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

    • info

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

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status