Skip to main content
GET
/
ai
/
embeddings
/
buckets
/
{bucket_name}
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);
import os
from telnyx import Telnyx

client = Telnyx(
api_key=os.environ.get("TELNYX_API_KEY"), # This is the default and can be omitted
)
bucket = client.ai.embeddings.buckets.retrieve(
"bucket_name",
)
print(bucket.data)
package main

import (
"context"
"fmt"

"github.com/team-telnyx/telnyx-go"
"github.com/team-telnyx/telnyx-go/option"
)

func main() {
client := telnyx.NewClient(
option.WithAPIKey("My API Key"),
)
bucket, err := client.AI.Embeddings.Buckets.Get(context.TODO(), "bucket_name")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", bucket.Data)
}
package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.ai.embeddings.buckets.BucketRetrieveParams;
import com.telnyx.sdk.models.ai.embeddings.buckets.BucketRetrieveResponse;

public final class Main {
private Main() {}

public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();

BucketRetrieveResponse bucket = client.ai().embeddings().buckets().retrieve("bucket_name");
}
}
require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

bucket = telnyx.ai.embeddings.buckets.retrieve("bucket_name")

puts(bucket)
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
$bucket = $client->ai->embeddings->buckets->retrieve('bucket_name');

var_dump($bucket);
} catch (APIException $e) {
echo $e->getMessage();
}
telnyx ai:embeddings:buckets retrieve \
--api-key 'My API Key' \
--bucket-name bucket_name
curl --request GET \
--url https://api.telnyx.com/v2/ai/embeddings/buckets/{bucket_name} \
--header 'Authorization: Bearer <token>'
{
  "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>"
    }
  ]
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<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

Name of the bucket.

Response

Successful Response

data
EmbeddingsBucketFiles · object[]
required