Get file-level embedding statuses for a bucket

Get all embedded files for a given user bucket, including their processing status.

GET /ai/embeddings/buckets/{bucket_name}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const bucket = await client.ai.embeddings.buckets.retrieve('bucket_name');

console.log(bucket.data);

200

{
  "data": [
    {
      "filename": "<string>",
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "last_embedded_at": "2023-11-07T05:31:56Z",
      "error_reason": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

bucket_name · string · required

Response

200

application/json

Successful Response

data · EmbeddingsBucketFiles · object[] · required

Show child attributes