Bucket

The bucket source indexes the files in one specific Telnyx Storage bucket. Attach multiple bucket sources to cover multiple buckets.

Searching bucket sources is coming soon. You can attach a bucket source today; its files are skipped by search until then.

Where this data comes from

Bucket records are the objects stored in Telnyx Cloud Storage, the S3-compatible object store. Upload files to a bucket with the S3 API or the portal (see Get Files Into a Bucket below); the bucket source indexes that one bucket’s contents by its bucket_id.

Get Files Into a Bucket

Upload documents with the S3-compatible API or the portal — see the Cloud Storage quickstart. To search one bucket’s documents directly today, use the Embeddings API.

Attach the Source

A bucket source is the only type with required configuration — its bucket_id:

curl -X POST https://api.telnyx.com/v2/ai/collections/{uuid}/sources \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "source_type": "bucket", "bucket_id": "policy-docs" }'

Omitting bucket_id returns 422:

{
  "errors": [{
    "code": "invalid_source_configuration",
    "title": "Invalid source configuration",
    "detail": "The bucket_id field is required when source_type is bucket.",
    "source": { "pointer": "/bucket_id" }
  }]
}

Buckets are reconciled by source_type + bucket_id, so the same bucket can back many collections. Removing a bucket source never touches the bucket’s contents.

See all source types on the Sources overview.

AI Search

Concepts

Configuration

API

For AI Agents

Where this data comes from

Get Files Into a Bucket

Attach the Source

​Where this data comes from

​Get Files Into a Bucket

​Attach the Source

Where this data comes from

Get Files Into a Bucket

Attach the Source