telnyx-ai-inference-curl

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Telnyx Ai Inference - curl

Telnyx AI 推理 - curl 示例

Installation

安装

text

undefined

text

undefined

curl is pre-installed on macOS, Linux, and Windows 10+

curl 已预装在 macOS、Linux 和 Windows 10+ 系统中

undefined

undefined

Setup

配置

bash

export TELNYX_API_KEY="YOUR_API_KEY_HERE"

All examples below use

$TELNYX_API_KEY

for authentication.

bash

export TELNYX_API_KEY="YOUR_API_KEY_HERE"

以下所有示例都使用

$TELNYX_API_KEY

进行身份验证。

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:

bash

undefined

所有 API 调用都可能失败，原因包括网络错误、速率限制(429)、校验错误(422)或身份验证错误(401)。在生产代码中请始终做好错误处理：

bash

undefined

Check HTTP status code in response

检查响应中的 HTTP 状态码

response=$(curl -s -w "\n%{http_code}"
-X POST "https://api.telnyx.com/v2/messages"
-H "Authorization: Bearer $TELNYX_API_KEY"
-H "Content-Type: application/json"
-d '{"to": "+13125550001", "from": "+13125550002", "text": "Hello"}')

http_code=$(echo "$response" | tail -1) body=$(echo "$response" | sed '$d')

case $http_code in 2*) echo "Success: $body" ;; 422) echo "Validation error — check required fields and formats" ;; 429) echo "Rate limited — retry after delay"; sleep 1 ;; 401) echo "Authentication failed — check TELNYX_API_KEY" ;; *) echo "Error $http_code: $body" ;; esac


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).

http_code=$(echo "$response" | tail -1) body=$(echo "$response" | sed '$d')

case $http_code in 2*) echo "请求成功: $body" ;; 422) echo "校验错误 — 请检查必填字段和格式" ;; 429) echo "触发速率限制 — 延迟后重试"; sleep 1 ;; 401) echo "身份验证失败 — 请检查 TELNYX_API_KEY" ;; *) echo "错误 $http_code: $body" ;; esac


常见错误码：`401` 无效API密钥，`403` 权限不足，`404` 资源不存在，`422` 校验错误（请检查字段格式），`429` 速率受限（请使用指数退避策略重试）。

Important Notes

重要说明

Pagination: List endpoints return paginated results. Use
```
page[number]
```
and
```
page[size]
```
query parameters to navigate pages. Check
```
meta.total_pages
```
in the response.

分页： 列表接口返回分页结果，使用
```
page[number]
```
和
```
page[size]
```
查询参数进行翻页，可查看响应中的
```
meta.total_pages
```
获取总页数。

Transcribe speech to text

语音转文字

Transcribe speech to text. This endpoint is consistent with the OpenAI Transcription API and may be used with the OpenAI JS or Python SDK.

POST /ai/audio/transcriptions

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -F "file=@/path/to/file" \
  -F "file_url=https://example.com/file.mp3" \
  -F "model=distil-whisper/distil-large-v2" \
  -F "response_format=json" \
  -F "timestamp_granularities[]=segment" \
  -F "language=en-US" \
  -F "model_config={'smart_format': True, 'punctuate': True}" \
  "https://api.telnyx.com/v2/ai/audio/transcriptions"

Returns:

duration

(number),

segments

(array[object]),

text

(string)

将语音转录为文本，该接口与 OpenAI Transcription API 兼容，可配合OpenAI的JS或Python SDK使用。

POST /ai/audio/transcriptions

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -F "file=@/path/to/file" \
  -F "file_url=https://example.com/file.mp3" \
  -F "model=distil-whisper/distil-large-v2" \
  -F "response_format=json" \
  -F "timestamp_granularities[]=segment" \
  -F "language=en-US" \
  -F "model_config={'smart_format': True, 'punctuate': True}" \
  "https://api.telnyx.com/v2/ai/audio/transcriptions"

返回参数：

duration

（数值）、

segments

（对象数组）、

text

（字符串）

Create a chat completion

创建聊天补全

Chat with a language model. This endpoint is consistent with the OpenAI Chat Completions API and may be used with the OpenAI JS or Python SDK.

POST /ai/chat/completions

— Required:

messages

Optional:

api_key_ref

(string),

best_of

(integer),

early_stopping

(boolean),

enable_thinking

(boolean),

frequency_penalty

(number),

guided_choice

(array[string]),

guided_json

(object),

guided_regex

(string),

length_penalty

(number),

logprobs

(boolean),

max_tokens

(integer),

min_p

(number),

model

(string),

(number),

presence_penalty

(number),

response_format

(object),

stream

(boolean),

temperature

(number),

tool_choice

(enum: none, auto, required),

tools

(array[object]),

top_logprobs

(integer),

top_p

(number),

use_beam_search

(boolean)

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "messages": [
    {
      "role": "system",
      "content": "You are a friendly chatbot."
    },
    {
      "role": "user",
      "content": "Hello, world!"
    }
  ]
}' \
  "https://api.telnyx.com/v2/ai/chat/completions"

与大语言模型对话，该接口与 OpenAI Chat Completions API 兼容，可配合OpenAI的JS或Python SDK使用。

POST /ai/chat/completions

— 必填参数：

messages

可选参数：

api_key_ref

（字符串）、

best_of

（整数）、

early_stopping

（布尔值）、

enable_thinking

（布尔值）、

frequency_penalty

（数值）、

guided_choice

（字符串数组）、

guided_json

（对象）、

guided_regex

（字符串）、

length_penalty

（数值）、

logprobs

（布尔值）、

max_tokens

（整数）、

min_p

（数值）、

model

（字符串）、

（数值）、

presence_penalty

（数值）、

response_format

（对象）、

stream

（布尔值）、

temperature

（数值）、

tool_choice

（枚举值：none, auto, required）、

tools

（对象数组）、

top_logprobs

（整数）、

top_p

（数值）、

use_beam_search

（布尔值）

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "messages": [
    {
      "role": "system",
      "content": "You are a friendly chatbot."
    },
    {
      "role": "user",
      "content": "Hello, world!"
    }
  ]
}' \
  "https://api.telnyx.com/v2/ai/chat/completions"

List conversations

获取对话列表

Retrieve a list of all AI conversations configured by the user. Supports PostgREST-style query parameters 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

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations"

Returns:

created_at

(date-time),

id

(uuid),

last_message_at

(date-time),

metadata

(object),

name

(string)

获取用户配置的所有AI对话列表，支持 PostgREST风格查询参数进行筛选。示例中包含了标准元数据字段的筛选方式，你也可以对元数据JSON对象中的任意字段进行筛选。

GET /ai/conversations

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations"

返回参数：

created_at

（日期时间）、

id

（uuid）、

last_message_at

（日期时间）、

metadata

（对象）、

name

（字符串）

Create a conversation

创建对话

Create a new AI Conversation.

POST /ai/conversations

Optional:

metadata

(object),

name

(string)

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/ai/conversations"

Returns:

created_at

(date-time),

id

(uuid),

last_message_at

(date-time),

metadata

(object),

name

(string)

创建新的AI对话。

POST /ai/conversations

可选参数：

metadata

（对象）、

name

（字符串）

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/ai/conversations"

返回参数：

created_at

（日期时间）、

id

（uuid）、

last_message_at

（日期时间）、

metadata

（对象）、

name

（字符串）

Get Insight Template Groups

获取洞察模板分组

Get all insight groups

GET /ai/conversations/insight-groups

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations/insight-groups"

Returns:

created_at

(date-time),

description

(string),

id

(uuid),

insights

(array[object]),

name

(string),

webhook

(string)

获取所有洞察分组

GET /ai/conversations/insight-groups

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations/insight-groups"

返回参数：

created_at

（日期时间）、

description

（字符串）、

id

（uuid）、

insights

（对象数组）、

name

（字符串）、

webhook

（字符串）

Create Insight Template Group

创建洞察模板分组

Create a new insight group

POST /ai/conversations/insight-groups

— Required:

name

Optional:

description

(string),

webhook

(string)

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "my-resource"
}' \
  "https://api.telnyx.com/v2/ai/conversations/insight-groups"

Returns:

created_at

(date-time),

description

(string),

id

(uuid),

insights

(array[object]),

name

(string),

webhook

(string)

创建新的洞察分组

POST /ai/conversations/insight-groups

— 必填参数：

name

可选参数：

description

（字符串）、

webhook

（字符串）

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "my-resource"
}' \
  "https://api.telnyx.com/v2/ai/conversations/insight-groups"

返回参数：

created_at

（日期时间）、

description

（字符串）、

id

（uuid）、

insights

（对象数组）、

name

（字符串）、

webhook

（字符串）

Get Insight Template Group

获取单个洞察模板分组

Get insight group by ID

GET /ai/conversations/insight-groups/{group_id}

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations/insight-groups/{group_id}"

Returns:

created_at

(date-time),

description

(string),

id

(uuid),

insights

(array[object]),

name

(string),

webhook

(string)

根据ID获取洞察分组

GET /ai/conversations/insight-groups/{group_id}

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations/insight-groups/{group_id}"

返回参数：

created_at

（日期时间）、

description

（字符串）、

id

（uuid）、

insights

（对象数组）、

name

（字符串）、

webhook

（字符串）

Update Insight Template Group

更新洞察模板分组

Update an insight template group

PUT /ai/conversations/insight-groups/{group_id}

Optional:

description

(string),

name

(string),

webhook

(string)

bash

curl \
  -X PUT \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/ai/conversations/insight-groups/{group_id}"

Returns:

created_at

(date-time),

description

(string),

id

(uuid),

insights

(array[object]),

name

(string),

webhook

(string)

更新洞察模板分组

PUT /ai/conversations/insight-groups/{group_id}

可选参数：

description

（字符串）、

name

（字符串）、

webhook

（字符串）

bash

curl \
  -X PUT \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/ai/conversations/insight-groups/{group_id}"

返回参数：

created_at

（日期时间）、

description

（字符串）、

id

（uuid）、

insights

（对象数组）、

name

（字符串）、

webhook

（字符串）

Delete Insight Template Group

删除洞察模板分组

Delete insight group by ID

DELETE /ai/conversations/insight-groups/{group_id}

bash

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/ai/conversations/insight-groups/{group_id}"

根据ID删除洞察分组

DELETE /ai/conversations/insight-groups/{group_id}

bash

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/ai/conversations/insight-groups/{group_id}"

Assign Insight Template To Group

分配洞察模板到分组

Assign an insight to a group

POST /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/assign

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/ai/conversations/insight-groups/{group_id}/insights/{insight_id}/assign"

将洞察分配到指定分组

POST /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/assign

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/ai/conversations/insight-groups/{group_id}/insights/{insight_id}/assign"

Unassign Insight Template From Group

从分组移除洞察模板

Remove an insight from a group

DELETE /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/unassign

bash

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/ai/conversations/insight-groups/{group_id}/insights/{insight_id}/unassign"

从指定分组中移除洞察

DELETE /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/unassign

bash

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/ai/conversations/insight-groups/{group_id}/insights/{insight_id}/unassign"

Get Insight Templates

获取洞察模板列表

Get all insights

GET /ai/conversations/insights

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations/insights"

Returns:

created_at

(date-time),

id

(uuid),

insight_type

(enum: custom, default),

instructions

(string),

json_schema

(object),

name

(string),

webhook

(string)

获取所有洞察

GET /ai/conversations/insights

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations/insights"

返回参数：

created_at

（日期时间）、

id

（uuid）、

insight_type

（枚举值：custom, default）、

instructions

（字符串）、

json_schema

（对象）、

name

（字符串）、

webhook

（字符串）

Create Insight Template

创建洞察模板

Create a new insight

POST /ai/conversations/insights

— Required:

instructions

name

Optional:

json_schema

(object),

webhook

(string)

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "instructions": "You are a helpful assistant.",
  "name": "my-resource"
}' \
  "https://api.telnyx.com/v2/ai/conversations/insights"

Returns:

created_at

(date-time),

id

(uuid),

insight_type

(enum: custom, default),

instructions

(string),

json_schema

(object),

name

(string),

webhook

(string)

创建新的洞察

POST /ai/conversations/insights

— 必填参数：

instructions

、

name

可选参数：

json_schema

（对象）、

webhook

（字符串）

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "instructions": "You are a helpful assistant.",
  "name": "my-resource"
}' \
  "https://api.telnyx.com/v2/ai/conversations/insights"

返回参数：

created_at

（日期时间）、

id

（uuid）、

insight_type

（枚举值：custom, default）、

instructions

（字符串）、

json_schema

（对象）、

name

（字符串）、

webhook

（字符串）

Get Insight Template

获取单个洞察模板

Get insight by ID

GET /ai/conversations/insights/{insight_id}

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations/insights/{insight_id}"

Returns:

created_at

(date-time),

id

(uuid),

insight_type

(enum: custom, default),

instructions

(string),

json_schema

(object),

name

(string),

webhook

(string)

根据ID获取洞察

GET /ai/conversations/insights/{insight_id}

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations/insights/{insight_id}"

返回参数：

created_at

（日期时间）、

id

（uuid）、

insight_type

（枚举值：custom, default）、

instructions

（字符串）、

json_schema

（对象）、

name

（字符串）、

webhook

（字符串）

Update Insight Template

更新洞察模板

Update an insight template

PUT /ai/conversations/insights/{insight_id}

Optional:

instructions

(string),

json_schema

(object),

name

(string),

webhook

(string)

bash

curl \
  -X PUT \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/ai/conversations/insights/{insight_id}"

Returns:

created_at

(date-time),

id

(uuid),

insight_type

(enum: custom, default),

instructions

(string),

json_schema

(object),

name

(string),

webhook

(string)

更新洞察模板

PUT /ai/conversations/insights/{insight_id}

可选参数：

instructions

（字符串）、

json_schema

（对象）、

name

（字符串）、

webhook

（字符串）

bash

curl \
  -X PUT \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/ai/conversations/insights/{insight_id}"

返回参数：

created_at

（日期时间）、

id

（uuid）、

insight_type

（枚举值：custom, default）、

instructions

（字符串）、

json_schema

（对象）、

name

（字符串）、

webhook

（字符串）

Delete Insight Template

删除洞察模板

Delete insight by ID

DELETE /ai/conversations/insights/{insight_id}

bash

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/ai/conversations/insights/{insight_id}"

根据ID删除洞察

DELETE /ai/conversations/insights/{insight_id}

bash

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/ai/conversations/insights/{insight_id}"

Get a conversation

获取单个对话

Retrieve a specific AI conversation by its ID.

GET /ai/conversations/{conversation_id}

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations/550e8400-e29b-41d4-a716-446655440000"

Returns:

created_at

(date-time),

id

(uuid),

last_message_at

(date-time),

metadata

(object),

name

(string)

根据ID获取指定的AI对话。

GET /ai/conversations/{conversation_id}

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations/550e8400-e29b-41d4-a716-446655440000"

返回参数：

created_at

（日期时间）、

id

（uuid）、

last_message_at

（日期时间）、

metadata

（对象）、

name

（字符串）

Update conversation metadata

更新对话元数据

Update metadata for a specific conversation.

PUT /ai/conversations/{conversation_id}

Optional:

metadata

(object)

bash

curl \
  -X PUT \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/ai/conversations/550e8400-e29b-41d4-a716-446655440000"

Returns:

created_at

(date-time),

id

(uuid),

last_message_at

(date-time),

metadata

(object),

name

(string)

更新指定对话的元数据。

PUT /ai/conversations/{conversation_id}

可选参数：

metadata

（对象）

bash

curl \
  -X PUT \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/ai/conversations/550e8400-e29b-41d4-a716-446655440000"

返回参数：

created_at

（日期时间）、

id

（uuid）、

last_message_at

（日期时间）、

metadata

（对象）、

name

（字符串）

Delete a conversation

删除对话

Delete a specific conversation by its ID.

DELETE /ai/conversations/{conversation_id}

bash

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/ai/conversations/550e8400-e29b-41d4-a716-446655440000"

根据ID删除指定对话。

DELETE /ai/conversations/{conversation_id}

bash

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/ai/conversations/550e8400-e29b-41d4-a716-446655440000"

Get insights for a conversation

获取对话洞察

Retrieve insights for a specific conversation

GET /ai/conversations/{conversation_id}/conversations-insights

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations/550e8400-e29b-41d4-a716-446655440000/conversations-insights"

Returns:

conversation_insights

(array[object]),

created_at

(date-time),

id

(string),

status

(enum: pending, in_progress, completed, failed)

获取指定对话的洞察

GET /ai/conversations/{conversation_id}/conversations-insights

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations/550e8400-e29b-41d4-a716-446655440000/conversations-insights"

返回参数：

conversation_insights

（对象数组）、

created_at

（日期时间）、

id

（字符串）、

status

（枚举值：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)

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "role": "user"
}' \
  "https://api.telnyx.com/v2/ai/conversations/550e8400-e29b-41d4-a716-446655440000/message"

向对话中添加新消息，用于手动向对话插入新消息（无需使用聊天接口）

POST /ai/conversations/{conversation_id}/message

— 必填参数：

role

可选参数：

content

（字符串）、

metadata

（对象）、

name

（字符串）、

sent_at

（日期时间）、

tool_call_id

（字符串）、

tool_calls

（对象数组）、

tool_choice

（对象）

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "role": "user"
}' \
  "https://api.telnyx.com/v2/ai/conversations/550e8400-e29b-41d4-a716-446655440000/message"

Get conversation messages

获取对话消息列表

Retrieve messages for a specific conversation, including tool calls made by the assistant.

GET /ai/conversations/{conversation_id}/messages

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations/550e8400-e29b-41d4-a716-446655440000/messages"

Returns:

created_at

(date-time),

role

(enum: user, assistant, tool),

sent_at

(date-time),

text

(string),

tool_calls

(array[object])

获取指定对话的消息，包括助手发起的工具调用。

GET /ai/conversations/{conversation_id}/messages

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/conversations/550e8400-e29b-41d4-a716-446655440000/messages"

返回参数：

created_at

（日期时间）、

role

（枚举值：user, assistant, tool）、

sent_at

（日期时间）、

text

（字符串）、

tool_calls

（对象数组）

Get Tasks by Status

按状态获取任务

Retrieve tasks for the user that are either

queued

processing

failed

success

partial_success

based on the query string. Defaults to

queued

and

processing

GET /ai/embeddings

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/embeddings"

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)

根据查询字符串获取用户的任务，状态可选

queued

、

processing

、

failed

、

success

或

partial_success

，默认返回

queued

和

processing

状态的任务。

GET /ai/embeddings

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/embeddings"

返回参数：

bucket

（字符串）、

created_at

（日期时间）、

finished_at

（日期时间）、

status

（枚举值：queued, processing, success, failure, partial_success）、

task_id

（字符串）、

task_name

（字符串）、

user_id

（字符串）

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)

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "bucket_name": "my-bucket"
}' \
  "https://api.telnyx.com/v2/ai/embeddings"

Returns:

created_at

(string),

finished_at

(string | null),

status

(string),

task_id

(uuid),

task_name

(string),

user_id

(uuid)

使用嵌入模型对 Telnyx 存储桶中的文档生成嵌入向量，当前支持的文件类型如下：

PDF
HTML
txt/非结构化文本文件
json
csv
音频/视频（mp3、mp4、mpeg、mpga、m4a、wav 或 webm ）- 文件大小上限为100MB。不符合上述类型的文件将尝试作为非结构化文本生成嵌入向量。

POST /ai/embeddings

— 必填参数：

bucket_name

可选参数：

document_chunk_overlap_size

（整数）、

document_chunk_size

（整数）、

embedding_model

（对象）、

loader

（对象）

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "bucket_name": "my-bucket"
}' \
  "https://api.telnyx.com/v2/ai/embeddings"

返回参数：

created_at

（字符串）、

finished_at

（字符串 | null）、

status

（字符串）、

task_id

（uuid）、

task_name

（字符串）、

user_id

（uuid）

List embedded buckets

获取向量化存储桶列表

Get all embedding buckets for a user.

GET /ai/embeddings/buckets

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/embeddings/buckets"

Returns:

buckets

(array[string])

获取用户所有已生成嵌入向量的存储桶。

GET /ai/embeddings/buckets

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/embeddings/buckets"

返回参数：

buckets

（字符串数组）

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}

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/embeddings/buckets/{bucket_name}"

Returns:

created_at

(date-time),

error_reason

(string),

filename

(string),

last_embedded_at

(date-time),

status

(string),

updated_at

(date-time)

获取指定用户存储桶中所有已向量化文件的处理状态。

GET /ai/embeddings/buckets/{bucket_name}

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/embeddings/buckets/{bucket_name}"

返回参数：

created_at

（日期时间）、

error_reason

（字符串）、

filename

（字符串）、

last_embedded_at

（日期时间）、

status

（字符串）、

updated_at

（日期时间）

Disable AI for an Embedded Bucket

禁用存储桶的AI向量化功能

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}

bash

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/ai/embeddings/buckets/{bucket_name}"

删除存储桶的全部嵌入向量并禁用该存储桶的AI功能，恢复为普通存储计费模式。

DELETE /ai/embeddings/buckets/{bucket_name}

bash

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/ai/embeddings/buckets/{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)

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "bucket_name": "my-bucket",
  "query": "What is Telnyx?"
}' \
  "https://api.telnyx.com/v2/ai/embeddings/similarity-search"

Returns:

distance

(number),

document_chunk

(string),

metadata

(object)

对 Telnyx 存储桶执行相似性搜索，返回与查询最相似的

num_docs

个文档片段。当前仅支持余弦相似度作为距离度量，返回的

distance

值范围为0到1，值越低表示返回的文档片段与查询越相似。

POST /ai/embeddings/similarity-search

— 必填参数：

bucket_name

、

query

可选参数：

num_of_docs

（整数）

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "bucket_name": "my-bucket",
  "query": "What is Telnyx?"
}' \
  "https://api.telnyx.com/v2/ai/embeddings/similarity-search"

返回参数：

distance

（数值）、

document_chunk

（字符串）、

metadata

（对象）

Embed URL content

URL内容向量化

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

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/resource",
  "bucket_name": "my-bucket"
}' \
  "https://api.telnyx.com/v2/ai/embeddings/url"

Returns:

created_at

(string),

finished_at

(string | null),

status

(string),

task_id

(uuid),

task_name

(string),

user_id

(uuid)

为指定URL的网站内容生成嵌入向量，包括同域名下最多5层深度的子页面。该流程会爬取主URL及其关联页面的内容并加载到 Telnyx 云存储桶中。

POST /ai/embeddings/url

— 必填参数：

url

、

bucket_name

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://example.com/resource",
  "bucket_name": "my-bucket"
}' \
  "https://api.telnyx.com/v2/ai/embeddings/url"

返回参数：

created_at

（字符串）、

finished_at

（字符串 | null）、

status

（字符串）、

task_id

（uuid）、

task_name

（字符串）、

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}

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/embeddings/{task_id}"

Returns:

created_at

(string),

finished_at

(string),

status

(enum: queued, processing, success, failure, partial_success),

task_id

(uuid),

task_name

(string)

检查当前向量化任务的状态，可选状态如下：

```
queued
```
- 任务正在等待工作节点处理
```
processing
```
- 向量化任务正在运行
```
success
```
- 任务执行成功，存储桶已完成向量化
```
failure
```
- 任务失败，无文件成功生成嵌入向量
```
partial_success
```
- 部分文件成功生成嵌入向量，但至少有一个文件处理失败

GET /ai/embeddings/{task_id}

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/embeddings/{task_id}"

返回参数：

created_at

（字符串）、

finished_at

（字符串）、

status

（枚举值：queued, processing, success, failure, partial_success）、

task_id

（uuid）、

task_name

（字符串）

List fine tuning jobs

获取微调任务列表

Retrieve a list of all fine tuning jobs created by the user.

GET /ai/fine_tuning/jobs

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/fine_tuning/jobs"

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 /ai/fine_tuning/jobs

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/fine_tuning/jobs"

返回参数：

created_at

（整数）、

finished_at

（整数 | null）、

hyperparameters

（对象）、

id

（字符串）、

model

（字符串）、

organization_id

（字符串）、

status

（枚举值：queued, running, succeeded, failed, cancelled）、

trained_tokens

（整数 | null）、

training_file

（字符串）

Create a fine tuning job

创建微调任务

Create a new fine tuning job.

POST /ai/fine_tuning/jobs

— Required:

model

training_file

Optional:

hyperparameters

(object),

suffix

(string)

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "openai/gpt-4o",
  "training_file": "training-data.jsonl"
}' \
  "https://api.telnyx.com/v2/ai/fine_tuning/jobs"

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)

创建新的微调任务。

POST /ai/fine_tuning/jobs

— 必填参数：

model

、

training_file

可选参数：

hyperparameters

（对象）、

suffix

（字符串）

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "openai/gpt-4o",
  "training_file": "training-data.jsonl"
}' \
  "https://api.telnyx.com/v2/ai/fine_tuning/jobs"

返回参数：

created_at

（整数）、

finished_at

（整数 | null）、

hyperparameters

（对象）、

id

（字符串）、

model

（字符串）、

organization_id

（字符串）、

status

（枚举值：queued, running, succeeded, failed, cancelled）、

trained_tokens

（整数 | null）、

training_file

（字符串）

Get a fine tuning job

获取单个微调任务

Retrieve a fine tuning job by

job_id

GET /ai/fine_tuning/jobs/{job_id}

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/fine_tuning/jobs/{job_id}"

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)

根据

job_id

获取微调任务。

GET /ai/fine_tuning/jobs/{job_id}

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/fine_tuning/jobs/{job_id}"

返回参数：

created_at

（整数）、

finished_at

（整数 | null）、

hyperparameters

（对象）、

id

（字符串）、

model

（字符串）、

organization_id

（字符串）、

status

（枚举值：queued, running, succeeded, failed, cancelled）、

trained_tokens

（整数 | null）、

training_file

（字符串）

Cancel a fine tuning job

取消微调任务

Cancel a fine tuning job.

POST /ai/fine_tuning/jobs/{job_id}/cancel

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/ai/fine_tuning/jobs/{job_id}/cancel"

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)

取消微调任务。

POST /ai/fine_tuning/jobs/{job_id}/cancel

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/ai/fine_tuning/jobs/{job_id}/cancel"

返回参数：

created_at

（整数）、

finished_at

（整数 | null）、

hyperparameters

（对象）、

id

（字符串）、

model

（字符串）、

organization_id

（字符串）、

status

（枚举值：queued, running, succeeded, failed, cancelled）、

trained_tokens

（整数 | null）、

training_file

（字符串）

Get available models

获取可用模型列表

This endpoint returns a list of Open Source and OpenAI models that are available for use. Note: Model

id

's will be in the form

{source}/{model_name}

. For example

openai/gpt-4

mistralai/Mistral-7B-Instruct-v0.1

consistent with HuggingFace naming conventions.

GET /ai/models

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/models"

Returns:

created

(integer),

id

(string),

object

(string),

owned_by

(string)

该接口返回可使用的开源模型和OpenAI模型列表。注意：模型

id

格式为

{source}/{model_name}

，例如

openai/gpt-4

或

mistralai/Mistral-7B-Instruct-v0.1

，遵循HuggingFace命名规范。

GET /ai/models

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/models"

返回参数：

created

（整数）、

id

（字符串）、

object

（字符串）、

owned_by

（字符串）

Create embeddings

生成嵌入向量

Creates an embedding vector representing the input text. This endpoint is compatible with the OpenAI Embeddings API 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)

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "input": "The quick brown fox jumps over the lazy dog",
  "model": "thenlper/gte-large"
}' \
  "https://api.telnyx.com/v2/ai/openai/embeddings"

Returns:

data

(array[object]),

model

(string),

object

(string),

usage

(object)

生成表示输入文本的嵌入向量。该接口与 OpenAI Embeddings API 兼容，将基础URL设置为

https://api.telnyx.com/v2/ai/openai

即可配合OpenAI的JS或Python SDK使用。

POST /ai/openai/embeddings

— 必填参数：

input

、

model

可选参数：

dimensions

（整数）、

encoding_format

（枚举值：float, base64）、

user

（字符串）

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "input": "The quick brown fox jumps over the lazy dog",
  "model": "thenlper/gte-large"
}' \
  "https://api.telnyx.com/v2/ai/openai/embeddings"

返回参数：

data

（对象数组）、

model

（字符串）、

object

（字符串）、

usage

（对象）

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

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/openai/embeddings/models"

Returns:

created

(integer),

id

(string),

object

(string),

owned_by

(string)

返回可用的嵌入模型列表，该接口兼容OpenAI Models API格式。

GET /ai/openai/embeddings/models

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/ai/openai/embeddings/models"

返回参数：

created

（整数）、

id

（字符串）、

object

（字符串）、

owned_by

（字符串）

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)

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "bucket": "my-bucket",
  "filename": "data.csv"
}' \
  "https://api.telnyx.com/v2/ai/summarize"

Returns:

summary

(string)

生成文件内容的摘要，支持以下文本格式：

PDF、HTML、txt、json、csv

支持以下媒体格式（按转录和摘要双重计费）：

flac、mp3、mp4、mpeg、mpga、m4a、ogg、wav 或 webm
大小上限100 MB

POST /ai/summarize

— 必填参数：

bucket

、

filename

可选参数：

system_prompt

（字符串）

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "bucket": "my-bucket",
  "filename": "data.csv"
}' \
  "https://api.telnyx.com/v2/ai/summarize"

返回参数：

summary

（字符串）

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

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/speech_to_text"

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 /legacy/reporting/batch_detail_records/speech_to_text

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/speech_to_text"

返回参数：

created_at

（日期时间）、

download_link

（字符串）、

end_date

（日期时间）、

id

（字符串）、

record_type

（字符串）、

start_date

（日期时间）、

status

（枚举值：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

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "start_date": "2020-07-01T00:00:00-06:00",
  "end_date": "2020-07-01T00:00:00-06:00"
}' \
  "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/speech_to_text"

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)

使用指定筛选条件创建新的语音转文字批量报表请求

POST /legacy/reporting/batch_detail_records/speech_to_text

— 必填参数：

start_date

、

end_date

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "start_date": "2020-07-01T00:00:00-06:00",
  "end_date": "2020-07-01T00:00:00-06:00"
}' \
  "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/speech_to_text"

返回参数：

created_at

（日期时间）、

download_link

（字符串）、

end_date

（日期时间）、

id

（字符串）、

record_type

（字符串）、

start_date

（日期时间）、

status

（枚举值：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}

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/speech_to_text/550e8400-e29b-41d4-a716-446655440000"

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)

根据ID获取指定的语音转文字批量报表请求

GET /legacy/reporting/batch_detail_records/speech_to_text/{id}

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/speech_to_text/550e8400-e29b-41d4-a716-446655440000"

返回参数：

created_at

（日期时间）、

download_link

（字符串）、

end_date

（日期时间）、

id

（字符串）、

record_type

（字符串）、

start_date

（日期时间）、

status

（枚举值：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}

bash

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/speech_to_text/550e8400-e29b-41d4-a716-446655440000"

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)

根据ID删除指定的语音转文字批量报表请求

DELETE /legacy/reporting/batch_detail_records/speech_to_text/{id}

bash

curl \
  -X DELETE \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  "https://api.telnyx.com/v2/legacy/reporting/batch_detail_records/speech_to_text/550e8400-e29b-41d4-a716-446655440000"

返回参数：

created_at

（日期时间）、

download_link

（字符串）、

end_date

（日期时间）、

id

（字符串）、

record_type

（字符串）、

start_date

（日期时间）、

status

（枚举值：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

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/usage_reports/speech_to_text?start_date=2020-07-02T00:00:00-06:00&end_date=2020-07-01T00:00:00-06:00"

Returns:

data

(object)

同步生成并获取语音转文字使用报表，该接口可在指定时间段内生成并获取语音转文字报表。

GET /legacy/reporting/usage_reports/speech_to_text

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/legacy/reporting/usage_reports/speech_to_text?start_date=2020-07-02T00:00:00-06:00&end_date=2020-07-01T00:00:00-06:00"

返回参数：

data

（对象）

Speech to text over WebSocket

WebSocket 语音转文字

Open a WebSocket connection to stream audio and receive transcriptions in real-time. Authentication is provided via the standard

Authorization: Bearer

header. Supported engines:

Azure

Deepgram

Google

Telnyx

GET /speech-to-text/transcription

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/speech-to-text/transcription?transcription_engine=Telnyx&input_format=mp3&language=en-US&interim_results=True&endpointing=500&redact=pci&keyterm=Telnyx&keywords=Telnyx,SIP,WebRTC"

建立WebSocket连接流式传输音频，实时获取转录结果。通过标准

Authorization: Bearer

头进行身份验证，支持的引擎：

Azure

、

Deepgram

、

Google

、

Telnyx

。

GET /speech-to-text/transcription

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/speech-to-text/transcription?transcription_engine=Telnyx&input_format=mp3&language=en-US&interim_results=True&endpointing=500&redact=pci&keyterm=Telnyx&keywords=Telnyx,SIP,WebRTC"

Stream text to speech over WebSocket

WebSocket 流式文本转语音

Open a WebSocket connection to stream text and receive synthesized audio in real time. Authentication is provided via the standard

Authorization: Bearer

header. Send JSON frames with text to synthesize; receive JSON frames containing base64-encoded audio chunks.

GET /text-to-speech/speech

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/text-to-speech/speech"

建立WebSocket连接流式传输文本，实时获取合成音频。通过标准

Authorization: Bearer

头进行身份验证，发送包含待合成文本的JSON帧，接收包含base64编码音频片段的JSON帧。

GET /text-to-speech/speech

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/text-to-speech/speech"

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),

language

(string),

minimax

(object),

output_type

(enum: binary_output, base64_output),

provider

(enum: aws, telnyx, azure, elevenlabs, minimax, rime, resemble),

resemble

(object),

rime

(object),

telnyx

(object),

text

(string),

text_type

(enum: text, ssml),

voice

(string),

voice_settings

(object)

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/text-to-speech/speech"

Returns:

base64_audio

(string)

从文本输入生成合成语音音频，以请求的格式返回（二进制音频流、base64编码JSON或可供后续获取的音频URL）。通过标准

Authorization: Bearer

头进行身份验证。

POST /text-to-speech/speech

可选参数：

aws

（对象）、

azure

（对象）、

disable_cache

（布尔值）、

elevenlabs

（对象）、

language

（字符串）、

minimax

（对象）、

output_type

（枚举值：binary_output, base64_output）、

provider

（枚举值：aws, telnyx, azure, elevenlabs, minimax, rime, resemble）、

resemble

（对象）、

rime

（对象）、

telnyx

（对象）、

text

（字符串）、

text_type

（枚举值：text, ssml）、

voice

（字符串）、

voice_settings

（对象）

bash

curl \
  -X POST \
  -H "Authorization: Bearer $TELNYX_API_KEY" \
  -H "Content-Type: application/json" \
  "https://api.telnyx.com/v2/text-to-speech/speech"

返回参数：

base64_audio

（字符串）

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

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/text-to-speech/voices"

Returns:

voices

(array[object])

获取单个或所有TTS服务商的可用音色列表。指定

provider

参数时仅返回对应服务商的音色，否则返回所有服务商的音色。

GET /text-to-speech/voices

bash

curl -H "Authorization: Bearer $TELNYX_API_KEY" "https://api.telnyx.com/v2/text-to-speech/voices"

返回参数：

voices

（对象数组）