Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Telnyx Embeddings API

Embed documents and perform text searches

Telnyx Embeddings API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Embeddings. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 8 operations across 6 paths, and defines 21 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.telnyx.com/v2.

8 operations 6 paths 21 schemas 1 DELETE4 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.telnyx.com/v2
Authentication
HTTP Bearer, HTTP Bearer, OAuth 2.0, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 6

Telnyx Embeddings API declares 6 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It accepts HTTP bearer tokens (branded-calling_bearerAuth). It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope. It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth). It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth). It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth). By default, every request must be authenticated.

  • branded-calling_bearerAuth — API key passed as a Bearer token in the Authorization header
  • oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
  • pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com

Paths & Operations 8

Across 6 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Embeddings 8

Embed documents and perform text searches

GET
/ai/embeddings
Get Tasks by Status
GetTasksByStatus 1 param → 200422
POST
/ai/embeddings
Embed documents
PostEmbedding body → 200422
GET
/ai/embeddings/buckets
List embedded buckets
GetEmbeddingBuckets → 200422
DELETE
/ai/embeddings/buckets/{bucket_name}
Disable AI for an Embedded Bucket
embedding_bucket_files_public_embedding_buckets__bucket_name__delete 1 param → 200404422
GET
/ai/embeddings/buckets/{bucket_name}
Get file-level embedding statuses for a bucket
GetBucketName 1 param → 200422
POST
/ai/embeddings/similarity-search
Search for documents
PostEmbeddingSimilaritySearch body → 200422
POST
/ai/embeddings/url
Embed URL content
PostEmbeddingUrl body → 200422
GET
/ai/embeddings/{task_id}
Get an embedding task's status
GetEmbeddingTask 1 param → 200422

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are BackgroundTasksQueryResponse (7 properties), EmbeddingMetadata (6 properties), EmbeddingsBucketFiles (6 properties), EmbeddingBucketRequest (5 properties). Each schema is shown below with its type and property counts.

SupportedEmbeddingModels
string
Supported models to vectorize and embed documents.
BucketNotFoundError
object
1 property
ValidationError
object
3 properties 3 required
EmbeddingMetadata
object
6 properties 4 required
BackgroundTaskStatus
string
Status of an embeddings task.
EmbeddingSimilaritySearchDocument
object
Example document response from embedding service { "documentchunk": "your status? This is Vanessa Bloome...", "distance": 0.18607724, "metadata": { "source": "…
3 properties 3 required
SupportedEmbeddingLoaders
string
Supported types of custom document loaders for embeddings.
HTTPValidationError
object
1 property
UserEmbeddedBucketsData
object
1 property 1 required
TaskStatusResponse
object
1 property 1 required
UserEmbeddedBuckets
object
1 property 1 required
BackgroundTasksQueryResponseData
object
1 property 1 required
BackgroundTasksQueryResponse
object
7 properties 5 required
NotFoundError
object
3 properties 1 required
EmbeddingsBucketFiles
object
6 properties 3 required
EmbeddingUrlRequest
object
2 properties 2 required
EmbeddingSimilaritySearchResponse
object
1 property 1 required
EmbeddingSimilaritySearchRequest
object
3 properties 2 required
EmbeddingsBucketFilesData
object
1 property 1 required
EmbeddingBucketRequest
object
5 properties 1 required
EmbeddingResponse
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-embeddings-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API