team-telnyx/ai / providers/claude/plugins/telnyx-platform/skills/telnyx-twilio-migration
telnyx-twilio-migration
UnverifiedMigrate from Twilio to Telnyx. Orchestrates a complete 6-phase migration: discovery, planning, setup, code migration, validation, and cleanup. Covers voice (TwiML to TeXML, Call Control API), messaging, WebRTC, SIP trunking, verify, fax, video, IoT, number lookup, and porting. Includes automated scanners, validation scripts, and integration tests.
sdk-reference/java/ai-inference.md
View on GitHub<!-- SDK reference: telnyx-ai-inference-java -->
# Telnyx Ai Inference - Java
## Installation
```text
<!-- Maven -->
<dependency>
<groupId>com.telnyx.sdk</groupId>
<artifactId>telnyx</artifactId>
<version>6.95.0</version>
</dependency>
// Gradle
implementation("com.telnyx.sdk:telnyx:6.95.0")
```
## Setup
```java
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
// fromEnv() reads TELNYX_API_KEY and TELNYX_PUBLIC_KEY (the public key is required for
// client.webhooks().unwrap() — webhook verification)
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
```
All examples below assume `client` is already initialized as shown above.
## Error Handling
All API calls can fail with network errors, rate limits (429), validation errors (422),
or authentication errors (401). Always handle errors in production code:
```java
import com.telnyx.sdk.errors.TelnyxServiceException;
try {
var result = client.messages().send(params);
} catch (TelnyxServiceException e) {
System.err.println("API error " + e.statusCode() + ": " + e.getMessage());
if (e.statusCode() == 422) {
System.err.println("Validation error — check required fields and formats");
} else if (e.statusCode() == 429) {
// Rate limited — wait, then retry the request (bounded exponential backoff)
Thread.sleep(1000);
// ...retry the call here (give up after a few attempts)
}
throw e; // Re-throw: a failed request must never look like success to the caller
}
```
Common error codes: `401` invalid API key, `403` insufficient permissions,
`404` resource not found, `422` validation error (check field formats),
`429` rate limited (retry with exponential backoff).
## Important Notes
- **Pagination:** List methods return a page. Use `.autoPager()` for automatic iteration: `for (var item : page.autoPager()) { ... }`. For manual control, use `.hasNextPage()` and `.nextPage()`.
## Transcribe speech to text
Transcribe speech to text. This endpoint is consistent with the [OpenAI Transcription API](https://platform.openai.com/docs/api-reference/audio/createTranscription) and may be used with the OpenAI JS or Python SDK.
`POST /ai/audio/transcriptions`
```java
import com.telnyx.sdk.models.ai.audio.AudioTranscribeParams;
import com.telnyx.sdk.models.ai.audio.AudioTranscribeResponse;
AudioTranscribeParams params = AudioTranscribeParams.builder()
.model(AudioTranscribeParams.Model.DISTIL_WHISPER_DISTIL_LARGE_V2)
.build();
AudioTranscribeResponse response = client.ai().audio().transcribe(params);
```
Returns: `duration` (number), `segments` (array[object]), `text` (string), `words` (array[object])
## List conversations
Retrieve a list of all AI conversations configured by the user. Supports [PostgREST-style query parameters](https://postgrest.org/en/stable/api.html#horizontal-filtering-rows) for filtering. Examples are included for the standard metadata fields, but you can filter on any field in the metadata JSON object.
`GET /ai/conversations`
```java
import com.telnyx.sdk.models.ai.conversations.ConversationListParams;
import com.telnyx.sdk.models.ai.conversations.ConversationListResponse;
ConversationListResponse conversations = client.ai().conversations().list();
```
Returns: `created_at` (date-time), `id` (uuid), `last_message_at` (date-time), `metadata` (object), `name` (string)
## Create a conversation
Creates a new AI conversation, the container for messages exchanged with an assistant, and returns the created conversation.
`POST /ai/conversations`
Optional: `metadata` (object), `name` (string)
```java
import com.telnyx.sdk.models.ai.conversations.Conversation;
import com.telnyx.sdk.models.ai.conversations.ConversationCreateParams;
Conversation conversation = client.ai().conversations().create();
```
Returns: `created_at` (date-time), `id` (uuid), `last_message_at` (date-time), `metadata` (object), `name` (string)
## Aggregate Conversation Insights
Aggregate conversation insights by specified fields
`GET /ai/conversations/conversation-insights/aggregates`
```java
var response = client.ai().conversations().conversationInsights().retrieveAggregates();
```
Returns: `record_count` (integer)
## Get Insight Template Groups
Returns a paginated list of your insight template groups. Groups organize related insight templates that are applied together when analyzing conversations.
`GET /ai/conversations/insight-groups`
```java
import com.telnyx.sdk.models.ai.conversations.insightgroups.InsightGroupRetrieveInsightGroupsPage;
import com.telnyx.sdk.models.ai.conversations.insightgroups.InsightGroupRetrieveInsightGroupsParams;
InsightGroupRetrieveInsightGroupsPage page = client.ai().conversations().insightGroups().retrieveInsightGroups();
```
Returns: `created_at` (date-time), `description` (string), `id` (uuid), `insights` (array[object]), `name` (string), `webhook` (string)
## Create Insight Template Group
Creates a new insight template group for organizing related insight templates, and returns the created group.
`POST /ai/conversations/insight-groups` — Required: `name`
Optional: `description` (string), `webhook` (string)
```java
import com.telnyx.sdk.models.ai.conversations.insightgroups.InsightGroupInsightGroupsParams;
import com.telnyx.sdk.models.ai.conversations.insightgroups.InsightTemplateGroupDetail;
InsightGroupInsightGroupsParams params = InsightGroupInsightGroupsParams.builder()
.name("my-resource")
.build();
InsightTemplateGroupDetail insightTemplateGroupDetail = client.ai().conversations().insightGroups().insightGroups(params);
```
Returns: `created_at` (date-time), `description` (string), `id` (uuid), `insights` (array[object]), `name` (string), `webhook` (string)
## Get Insight Template Group
Returns the details of a single insight template group, including the insight templates assigned to it.
`GET /ai/conversations/insight-groups/{group_id}`
```java
import com.telnyx.sdk.models.ai.conversations.insightgroups.InsightGroupRetrieveParams;
import com.telnyx.sdk.models.ai.conversations.insightgroups.InsightTemplateGroupDetail;
InsightTemplateGroupDetail insightTemplateGroupDetail = client.ai().conversations().insightGroups().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
```
Returns: `created_at` (date-time), `description` (string), `id` (uuid), `insights` (array[object]), `name` (string), `webhook` (string)
## Update Insight Template Group
Updates the specified insight template group and returns the updated group.
`PUT /ai/conversations/insight-groups/{group_id}`
Optional: `description` (string), `name` (string), `webhook` (string)
```java
import com.telnyx.sdk.models.ai.conversations.insightgroups.InsightGroupUpdateParams;
import com.telnyx.sdk.models.ai.conversations.insightgroups.InsightTemplateGroupDetail;
InsightTemplateGroupDetail insightTemplateGroupDetail = client.ai().conversations().insightGroups().update("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
```
Returns: `created_at` (date-time), `description` (string), `id` (uuid), `insights` (array[object]), `name` (string), `webhook` (string)
## Delete Insight Template Group
Permanently deletes the specified insight template group by its ID.
`DELETE /ai/conversations/insight-groups/{group_id}`
```java
import com.telnyx.sdk.models.ai.conversations.insightgroups.InsightGroupDeleteParams;
client.ai().conversations().insightGroups().delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
```
## Assign Insight Template To Group
Assigns the specified insight template to the specified insight template group.
`POST /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/assign`
```java
import com.telnyx.sdk.models.ai.conversations.insightgroups.insights.InsightAssignParams;
InsightAssignParams params = InsightAssignParams.builder()
.groupId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
.insightId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
.build();
client.ai().conversations().insightGroups().insights().assign(params);
```
## Unassign Insight Template From Group
Removes the specified insight template from the specified group. The insight template itself is not deleted.
`DELETE /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/unassign`
```java
import com.telnyx.sdk.models.ai.conversations.insightgroups.insights.InsightDeleteUnassignParams;
InsightDeleteUnassignParams params = InsightDeleteUnassignParams.builder()
.groupId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
.insightId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
.build();
client.ai().conversations().insightGroups().insights().deleteUnassign(params);
```
## Get Insight Templates
Returns a paginated list of your insight templates. Insight templates define analyses that run over AI conversations to extract structured findings.
`GET /ai/conversations/insights`
```java
import com.telnyx.sdk.models.ai.conversations.insights.InsightListPage;
import com.telnyx.sdk.models.ai.conversations.insights.InsightListParams;
InsightListPage page = client.ai().conversations().insights().list();
```
Returns: `created_at` (date-time), `id` (uuid), `insight_type` (enum: custom, default), `instructions` (string), `json_schema` (object), `name` (string), `webhook` (string)
## Create Insight Template
Creates a new insight template defining an analysis to run over conversations, and returns the created template.
`POST /ai/conversations/insights` — Required: `instructions`, `name`
Optional: `json_schema` (object), `webhook` (string)
```java
import com.telnyx.sdk.models.ai.conversations.insights.InsightCreateParams;
import com.telnyx.sdk.models.ai.conversations.insights.InsightTemplateDetail;
InsightCreateParams params = InsightCreateParams.builder()
.instructions("You are a helpful assistant.")
.name("my-resource")
.build();
InsightTemplateDetail insightTemplateDetail = client.ai().conversations().insights().create(params);
```
Returns: `created_at` (date-time), `id` (uuid), `insight_type` (enum: custom, default), `instructions` (string), `json_schema` (object), `name` (string), `webhook` (string)
## Get Insight Template
Returns the details of a single insight template by its ID, including its configuration.
`GET /ai/conversations/insights/{insight_id}`
```java
import com.telnyx.sdk.models.ai.conversations.insights.InsightRetrieveParams;
import com.telnyx.sdk.models.ai.conversations.insights.InsightTemplateDetail;
InsightTemplateDetail insightTemplateDetail = client.ai().conversations().insights().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
```
Returns: `created_at` (date-time), `id` (uuid), `insight_type` (enum: custom, default), `instructions` (string), `json_schema` (object), `name` (string), `webhook` (string)
## Update Insight Template
Updates the specified insight template and returns the updated template.
`PUT /ai/conversations/insights/{insight_id}`
Optional: `instructions` (string), `json_schema` (object), `name` (string), `webhook` (string)
```java
import com.telnyx.sdk.models.ai.conversations.insights.InsightTemplateDetail;
import com.telnyx.sdk.models.ai.conversations.insights.InsightUpdateParams;
InsightTemplateDetail insightTemplateDetail = client.ai().conversations().insights().update("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
```
Returns: `created_at` (date-time), `id` (uuid), `insight_type` (enum: custom, default), `instructions` (string), `json_schema` (object), `name` (string), `webhook` (string)
## Delete Insight Template
Permanently deletes the specified insight template by its ID.
`DELETE /ai/conversations/insights/{insight_id}`
```java
import com.telnyx.sdk.models.ai.conversations.insights.InsightDeleteParams;
client.ai().conversations().insights().delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
```
## Get a conversation
Retrieve a specific AI conversation by its ID.
`GET /ai/conversations/{conversation_id}`
```java
import com.telnyx.sdk.models.ai.conversations.ConversationRetrieveParams;
import com.telnyx.sdk.models.ai.conversations.ConversationRetrieveResponse;
ConversationRetrieveResponse conversation = client.ai().conversations().retrieve("550e8400-e29b-41d4-a716-446655440000");
```
Returns: `created_at` (date-time), `id` (uuid), `last_message_at` (date-time), `metadata` (object), `name` (string)
## Update conversation metadata
Update metadata for a specific conversation.
`PUT /ai/conversations/{conversation_id}`
Optional: `metadata` (object)
```java
import com.telnyx.sdk.models.ai.conversations.ConversationUpdateParams;
import com.telnyx.sdk.models.ai.conversations.ConversationUpdateResponse;
ConversationUpdateResponse conversation = client.ai().conversations().update("550e8400-e29b-41d4-a716-446655440000");
```
Returns: `created_at` (date-time), `id` (uuid), `last_message_at` (date-time), `metadata` (object), `name` (string)
## Delete a conversation
Delete a specific conversation by its ID.
`DELETE /ai/conversations/{conversation_id}`
```java
import com.telnyx.sdk.models.ai.conversations.ConversationDeleteParams;
client.ai().conversations().delete("550e8400-e29b-41d4-a716-446655440000");
```
## Get insights for a conversation
Retrieve insights for a specific conversation
`GET /ai/conversations/{conversation_id}/conversations-insights`
```java
import com.telnyx.sdk.models.ai.conversations.ConversationRetrieveConversationsInsightsParams;
import com.telnyx.sdk.models.ai.conversations.ConversationRetrieveConversationsInsightsResponse;
ConversationRetrieveConversationsInsightsResponse response = client.ai().conversations().retrieveConversationsInsights("550e8400-e29b-41d4-a716-446655440000");
```
Returns: `conversation_insights` (array[object]), `created_at` (date-time), `id` (string), `status` (enum: pending, in_progress, completed, failed)
## Create Message
Add a new message to the conversation. Used to insert a new messages to a conversation manually ( without using chat endpoint )
`POST /ai/conversations/{conversation_id}/message` — Required: `role`
Optional: `content` (string), `metadata` (object), `name` (string), `sent_at` (date-time), `tool_call_id` (string), `tool_calls` (array[object]), `tool_choice` (object)
```java
import com.telnyx.sdk.models.ai.conversations.ConversationAddMessageParams;
ConversationAddMessageParams params = ConversationAddMessageParams.builder()
.conversationId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
.role("user")
.build();
client.ai().conversations().addMessage(params);
```
## Get conversation messages
Retrieve messages for a specific conversation, including tool calls made by the assistant.
`GET /ai/conversations/{conversation_id}/messages`
```java
import com.telnyx.sdk.models.ai.conversations.messages.MessageListPage;
import com.telnyx.sdk.models.ai.conversations.messages.MessageListParams;
MessageListPage page = client.ai().conversations().messages().list("550e8400-e29b-41d4-a716-446655440000");
```
Returns: `created_at` (date-time), `metadata` (object), `role` (enum: user, assistant, tool), `sent_at` (date-time), `text` (string), `tool_calls` (array[object])
## Get Tasks by Status
Retrieve tasks for the user that are either `queued`, `processing`, `failed`, `success` or `partial_success` based on the query string. Defaults to `queued` and `processing`.
`GET /ai/embeddings`
```java
import com.telnyx.sdk.models.ai.embeddings.EmbeddingListParams;
import com.telnyx.sdk.models.ai.embeddings.EmbeddingListResponse;
EmbeddingListResponse embeddings = client.ai().embeddings().list();
```
Returns: `bucket` (string), `created_at` (date-time), `finished_at` (date-time), `status` (enum: queued, processing, success, failure, partial_success), `task_id` (string), `task_name` (string), `user_id` (string)
## Embed documents
Perform embedding on a Telnyx Storage Bucket using an embedding model. The current supported file types are:
- PDF
- HTML
- txt/unstructured text files
- json
- csv
- audio / video (mp3, mp4, mpeg, mpga, m4a, wav, or webm ) - Max of 100mb file size. Any files not matching the above types will be attempted to be embedded as unstructured text.
`POST /ai/embeddings` — Required: `bucket_name`
Optional: `document_chunk_overlap_size` (integer), `document_chunk_size` (integer), `embedding_model` (object), `loader` (object)
```java
import com.telnyx.sdk.models.ai.embeddings.EmbeddingCreateParams;
import com.telnyx.sdk.models.ai.embeddings.EmbeddingResponse;
EmbeddingCreateParams params = EmbeddingCreateParams.builder()
.bucketName("my-bucket")
.build();
EmbeddingResponse embeddingResponse = client.ai().embeddings().create(params);
```
Returns: `created_at` (string), `finished_at` (string | null), `status` (string), `task_id` (uuid), `task_name` (string), `user_id` (uuid)
## List embedded buckets
Returns the list of storage buckets that have been embedded for your account, for use with similarity search.
`GET /ai/embeddings/buckets`
```java
import com.telnyx.sdk.models.ai.embeddings.buckets.BucketListParams;
import com.telnyx.sdk.models.ai.embeddings.buckets.BucketListResponse;
BucketListResponse buckets = client.ai().embeddings().buckets().list();
```
Returns: `buckets` (array[string])
## 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}`
```java
import com.telnyx.sdk.models.ai.embeddings.buckets.BucketRetrieveParams;
import com.telnyx.sdk.models.ai.embeddings.buckets.BucketRetrieveResponse;
BucketRetrieveResponse bucket = client.ai().embeddings().buckets().retrieve("bucket_name");
```
Returns: `created_at` (date-time), `error_reason` (string), `filename` (string), `last_embedded_at` (date-time), `status` (string), `updated_at` (date-time)
## Disable AI for an Embedded Bucket
Deletes an entire bucket's embeddings and disables the bucket for AI-use, returning it to normal storage pricing.
`DELETE /ai/embeddings/buckets/{bucket_name}`
```java
import com.telnyx.sdk.models.ai.embeddings.buckets.BucketDeleteParams;
client.ai().embeddings().buckets().delete("bucket_name");
```
## Search for documents
Perform a similarity search on a Telnyx Storage Bucket, returning the most similar `num_docs` document chunks to the query. Currently the only available distance metric is cosine similarity which will return a `distance` between 0 and 1. The lower the distance, the more similar the returned document chunks are to the query.
`POST /ai/embeddings/similarity-search` — Required: `bucket_name`, `query`
Optional: `num_of_docs` (integer)
```java
import com.telnyx.sdk.models.ai.embeddings.EmbeddingSimilaritySearchParams;
import com.telnyx.sdk.models.ai.embeddings.EmbeddingSimilaritySearchResponse;
EmbeddingSimilaritySearchParams params = EmbeddingSimilaritySearchParams.builder()
.bucketName("my-bucket")
.query("What is Telnyx?")
.build();
EmbeddingSimilaritySearchResponse response = client.ai().embeddings().similaritySearch(params);
```
Returns: `distance` (number), `document_chunk` (string), `metadata` (object)
## Embed URL content
Embed website content from a specified URL, including child pages up to 5 levels deep within the same domain. The process crawls and loads content from the main URL and its linked pages into a Telnyx Cloud Storage bucket.
`POST /ai/embeddings/url` — Required: `url`, `bucket_name`
```java
import com.telnyx.sdk.models.ai.embeddings.EmbeddingResponse;
import com.telnyx.sdk.models.ai.embeddings.EmbeddingUrlParams;
EmbeddingUrlParams params = EmbeddingUrlParams.builder()
.bucketName("my-bucket")
.url("https://example.com/resource")
.build();
EmbeddingResponse embeddingResponse = client.ai().embeddings().url(params);
```
Returns: `created_at` (string), `finished_at` (string | null), `status` (string), `task_id` (uuid), `task_name` (string), `user_id` (uuid)
## Get an embedding task's status
Check the status of a current embedding task. Will be one of the following:
- `queued` - Task is waiting to be picked up by a worker
- `processing` - The embedding task is running
- `success` - Task completed successfully and the bucket is embedded
- `failure` - Task failed and no files were embedded successfully
- `partial_success` - Some files were embedded successfully, but at least one failed
`GET /ai/embeddings/{task_id}`
```java
import com.telnyx.sdk.models.ai.embeddings.EmbeddingRetrieveParams;
import com.telnyx.sdk.models.ai.embeddings.EmbeddingRetrieveResponse;
EmbeddingRetrieveResponse embedding = client.ai().embeddings().retrieve("550e8400-e29b-41d4-a716-446655440000");
```
Returns: `created_at` (string), `finished_at` (string), `status` (enum: queued, processing, success, failure, partial_success), `task_id` (uuid), `task_name` (string)
## List fine tuning jobs
Retrieve a list of all fine tuning jobs created by the user.
`GET /ai/fine_tuning/jobs`
```java
import com.telnyx.sdk.models.ai.finetuning.jobs.JobListParams;
import com.telnyx.sdk.models.ai.finetuning.jobs.JobListResponse;
JobListResponse jobs = client.ai().fineTuning().jobs().list();
```
Returns: `created_at` (integer), `finished_at` (integer | null), `hyperparameters` (object), `id` (string), `model` (string), `organization_id` (string), `status` (enum: queued, running, succeeded, failed, cancelled), `trained_tokens` (integer | null), `training_file` (string)
## Create a fine tuning job
Creates a new fine-tuning job that trains a model on the provided dataset, and returns the created job.
`POST /ai/fine_tuning/jobs` — Required: `model`, `training_file`
Optional: `hyperparameters` (object), `suffix` (string)
```java
import com.telnyx.sdk.models.ai.finetuning.jobs.FineTuningJob;
import com.telnyx.sdk.models.ai.finetuning.jobs.JobCreateParams;
JobCreateParams params = JobCreateParams.builder()
.model("openai/gpt-4o")
.trainingFile("training-data.jsonl")
.build();
FineTuningJob fineTuningJob = client.ai().fineTuning().jobs().create(params);
```
Returns: `created_at` (integer), `finished_at` (integer | null), `hyperparameters` (object), `id` (string), `model` (string), `organization_id` (string), `status` (enum: queued, running, succeeded, failed, cancelled), `trained_tokens` (integer | null), `training_file` (string)
## Get a fine tuning job
Returns the details of a single fine-tuning job by its job_id, including its current status.
`GET /ai/fine_tuning/jobs/{job_id}`
```java
import com.telnyx.sdk.models.ai.finetuning.jobs.FineTuningJob;
import com.telnyx.sdk.models.ai.finetuning.jobs.JobRetrieveParams;
FineTuningJob fineTuningJob = client.ai().fineTuning().jobs().retrieve("550e8400-e29b-41d4-a716-446655440000");
```
Returns: `created_at` (integer), `finished_at` (integer | null), `hyperparameters` (object), `id` (string), `model` (string), `organization_id` (string), `status` (enum: queued, running, succeeded, failed, cancelled), `trained_tokens` (integer | null), `training_file` (string)
## Cancel a fine tuning job
Cancels the specified in-progress fine-tuning job and returns the updated job.
`POST /ai/fine_tuning/jobs/{job_id}/cancel`
```java
import com.telnyx.sdk.models.ai.finetuning.jobs.FineTuningJob;
import com.telnyx.sdk.models.ai.finetuning.jobs.JobCancelParams;
FineTuningJob fineTuningJob = client.ai().fineTuning().jobs().cancel("550e8400-e29b-41d4-a716-446655440000");
```
Returns: `created_at` (integer), `finished_at` (integer | null), `hyperparameters` (object), `id` (string), `model` (string), `organization_id` (string), `status` (enum: queued, running, succeeded, failed, cancelled), `trained_tokens` (integer | null), `training_file` (string)
## Create embeddings
Creates an embedding vector representing the input text. This endpoint is compatible with the [OpenAI Embeddings API](https://platform.openai.com/docs/api-reference/embeddings) and may be used with the OpenAI JS or Python SDK by setting the base URL to `https://api.telnyx.com/v2/ai/openai`.
`POST /ai/openai/embeddings` — Required: `input`, `model`
Optional: `dimensions` (integer), `encoding_format` (enum: float, base64), `user` (string)
```java
import com.telnyx.sdk.models.ai.openai.embeddings.EmbeddingCreateEmbeddingsParams;
import com.telnyx.sdk.models.ai.openai.embeddings.EmbeddingCreateEmbeddingsResponse;
EmbeddingCreateEmbeddingsParams params = EmbeddingCreateEmbeddingsParams.builder()
.input("The quick brown fox jumps over the lazy dog")
.model("thenlper/gte-large")
.build();
EmbeddingCreateEmbeddingsResponse response = client.ai().openai().embeddings().createEmbeddings(params);
```
Returns: `data` (array[object]), `model` (string), `object` (string), `usage` (object)
## List embedding models
Returns a list of available embedding models. This endpoint is compatible with the OpenAI Models API format.
`GET /ai/openai/embeddings/models`
```java
import com.telnyx.sdk.models.ai.openai.embeddings.EmbeddingListEmbeddingModelsParams;
import com.telnyx.sdk.models.ai.openai.embeddings.EmbeddingListEmbeddingModelsResponse;
EmbeddingListEmbeddingModelsResponse response = client.ai().openai().embeddings().listEmbeddingModels();
```
Returns: `created` (integer), `id` (string), `object` (string), `owned_by` (string)
## Summarize file content
Generate a summary of a file's contents. Supports the following text formats:
- PDF, HTML, txt, json, csv
Supports the following media formats (billed for both the transcription and summary):
- flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm
- Up to 100 MB
`POST /ai/summarize` — Required: `bucket`, `filename`
Optional: `system_prompt` (string)
```java
import com.telnyx.sdk.models.ai.AiSummarizeParams;
import com.telnyx.sdk.models.ai.AiSummarizeResponse;
AiSummarizeParams params = AiSummarizeParams.builder()
.bucket("my-bucket")
.filename("data.csv")
.build();
AiSummarizeResponse response = client.ai().summarize(params);
```
Returns: `summary` (string)
## Get all Speech to Text batch report requests
Retrieves all Speech to Text batch report requests for the authenticated user
`GET /legacy/reporting/batch_detail_records/speech_to_text`
```java
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.speechtotext.SpeechToTextListParams;
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.speechtotext.SpeechToTextListResponse;
SpeechToTextListResponse speechToTexts = client.legacy().reporting().batchDetailRecords().speechToText().list();
```
Returns: `created_at` (date-time), `download_link` (string), `end_date` (date-time), `id` (string), `record_type` (string), `start_date` (date-time), `status` (enum: PENDING, COMPLETE, FAILED, EXPIRED)
## Create a new Speech to Text batch report request
Creates a new Speech to Text batch report request with the specified filters
`POST /legacy/reporting/batch_detail_records/speech_to_text` — Required: `start_date`, `end_date`
```java
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.speechtotext.SpeechToTextCreateParams;
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.speechtotext.SpeechToTextCreateResponse;
import java.time.OffsetDateTime;
SpeechToTextCreateParams params = SpeechToTextCreateParams.builder()
.endDate(OffsetDateTime.parse("2020-07-01T00:00:00-06:00"))
.startDate(OffsetDateTime.parse("2020-07-01T00:00:00-06:00"))
.build();
SpeechToTextCreateResponse speechToText = client.legacy().reporting().batchDetailRecords().speechToText().create(params);
```
Returns: `created_at` (date-time), `download_link` (string), `end_date` (date-time), `id` (string), `record_type` (string), `start_date` (date-time), `status` (enum: PENDING, COMPLETE, FAILED, EXPIRED)
## Get a specific Speech to Text batch report request
Retrieves a specific Speech to Text batch report request by ID
`GET /legacy/reporting/batch_detail_records/speech_to_text/{id}`
```java
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.speechtotext.SpeechToTextRetrieveParams;
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.speechtotext.SpeechToTextRetrieveResponse;
SpeechToTextRetrieveResponse speechToText = client.legacy().reporting().batchDetailRecords().speechToText().retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
```
Returns: `created_at` (date-time), `download_link` (string), `end_date` (date-time), `id` (string), `record_type` (string), `start_date` (date-time), `status` (enum: PENDING, COMPLETE, FAILED, EXPIRED)
## Delete a Speech to Text batch report request
Deletes a specific Speech to Text batch report request by ID
`DELETE /legacy/reporting/batch_detail_records/speech_to_text/{id}`
```java
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.speechtotext.SpeechToTextDeleteParams;
import com.telnyx.sdk.models.legacy.reporting.batchdetailrecords.speechtotext.SpeechToTextDeleteResponse;
SpeechToTextDeleteResponse speechToText = client.legacy().reporting().batchDetailRecords().speechToText().delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
```
Returns: `created_at` (date-time), `download_link` (string), `end_date` (date-time), `id` (string), `record_type` (string), `start_date` (date-time), `status` (enum: PENDING, COMPLETE, FAILED, EXPIRED)
## Get speech to text usage report
Generate and fetch speech to text usage report synchronously. This endpoint will both generate and fetch the speech to text report over a specified time period.
`GET /legacy/reporting/usage_reports/speech_to_text`
```java
import com.telnyx.sdk.models.legacy.reporting.usagereports.UsageReportRetrieveSpeechToTextParams;
import com.telnyx.sdk.models.legacy.reporting.usagereports.UsageReportRetrieveSpeechToTextResponse;
UsageReportRetrieveSpeechToTextResponse response = client.legacy().reporting().usageReports().retrieveSpeechToText();
```
Returns: `data` (object)
## Generate speech from text
Generate synthesized speech audio from text input. Returns audio in the requested format (binary audio stream, base64-encoded JSON, or an audio URL for later retrieval). Authentication is provided via the standard `Authorization: Bearer ` header.
`POST /text-to-speech/speech`
Optional: `aws` (object), `azure` (object), `disable_cache` (boolean), `elevenlabs` (object), `humain` (object), `language` (string), `minimax` (object), `output_type` (enum: binary_output, base64_output), `provider` (enum: aws, telnyx, azure, elevenlabs, minimax, resemble, xai, humain, soniox), `resemble` (object), `soniox` (object), `telnyx` (object), `text` (string), `text_type` (enum: text, ssml), `voice` (string), `voice_settings` (object), `xai` (object)
```java
import com.telnyx.sdk.models.texttospeech.TextToSpeechGenerateParams;
import com.telnyx.sdk.models.texttospeech.TextToSpeechGenerateResponse;
TextToSpeechGenerateResponse response = client.textToSpeech().generate();
```
Returns: `base64_audio` (string)
## List available voices
Retrieve a list of available voices from one or all TTS providers. When `provider` is specified, returns voices for that provider only. Otherwise, returns voices from all providers.
`GET /text-to-speech/voices`
```java
import com.telnyx.sdk.models.texttospeech.TextToSpeechListVoicesParams;
import com.telnyx.sdk.models.texttospeech.TextToSpeechListVoicesResponse;
TextToSpeechListVoicesResponse response = client.textToSpeech().listVoices();
```
Returns: `voices` (array[object])
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| finishing-a-development-branchobra/superpowersUse when implementation is complete, all tests pass, and you need to decide how to integrate the work | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| systematic-debuggingobra/superpowersUse when encountering any bug, test failure, or unexpected behavior, before proposing fixes | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| test-driven-developmentobra/superpowersUse when implementing any feature or bugfix, before writing implementation code | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| skill-creatoranthropics/skillsCreate new skills, modify and improve existing skills, and measure skill performance. Use when users want to create a skill from scratch, edit, or optimize an existing skill, run evals to test a skill, benchmark skill performance with variance analysis, or optimize a skill's description for better triggering accuracy. | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |