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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Telnyx

Telnyx Conversations API

Manage historical AI assistant conversations

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 20 operations across 11 paths, and defines 23 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.

20 operations 11 paths 23 schemas 4 DELETE8 GET5 POST3 PUT

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
Contact
support@telnyx.com
Resource Areas
1

Authentication & Security 6

Telnyx Conversations 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 20

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

Conversations 20

Manage historical AI assistant conversations

GET
/ai/conversations
List conversations
get_conversations_public_conversations_get 12 params → 200422
POST
/ai/conversations
Create a conversation
create_new_conversation_public_conversations_post body → 200422
GET
/ai/conversations/insight-groups
Get Insight Template Groups
get_all_insight_groups 1 param → 200422
POST
/ai/conversations/insight-groups
Create Insight Template Group
create_insight_group body → 200422
DELETE
/ai/conversations/insight-groups/{group_id}
Delete Insight Template Group
delete_insight_group_by_id 1 param → 200422
GET
/ai/conversations/insight-groups/{group_id}
Get Insight Template Group
get_insight_group_by_id 1 param → 200422
PUT
/ai/conversations/insight-groups/{group_id}
Update Insight Template Group
update_insight_group_by_id 1 param body → 200422
POST
/ai/conversations/insight-groups/{group_id}/insights/{insight_id}/assign
Assign Insight Template To Group
assign_insight_to_group 2 params → 200422
DELETE
/ai/conversations/insight-groups/{group_id}/insights/{insight_id}/unassign
Unassign Insight Template From Group
unassign_insight_from_group 2 params → 200422
GET
/ai/conversations/insights
Get Insight Templates
get_all_insights 1 param → 200422
POST
/ai/conversations/insights
Create Insight Template
create_insight body → 200422
DELETE
/ai/conversations/insights/{insight_id}
Delete Insight Template
delete_insight_by_id 1 param → 200422
GET
/ai/conversations/insights/{insight_id}
Get Insight Template
get_insight_by_id 1 param → 200422
PUT
/ai/conversations/insights/{insight_id}
Update Insight Template
update_insight_by_id 1 param body → 200422
DELETE
/ai/conversations/{conversation_id}
Delete a conversation
delete_conversation_by_id_public_conversations_delete 1 param → 200404422
GET
/ai/conversations/{conversation_id}
Get a conversation
get_conversation_by_id_public_conversations_get 1 param → 200404422
PUT
/ai/conversations/{conversation_id}
Update conversation metadata
update_conversation_by_id_public_conversations_put 1 param body → 200404422
GET
/ai/conversations/{conversation_id}/conversations-insights
Get insights for a conversation
get_conversations_public__conversation_id__insights_get 1 param → 200422
POST
/ai/conversations/{conversation_id}/message
Create Message
add_new_message 1 param body → 200422
GET
/ai/conversations/{conversation_id}/messages
Get conversation messages
get_conversations_public__conversation_id__messages_get 3 params → 200422

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are CreateMsgReq (8 properties), InsightTemplateResp (7 properties), InsightTemplateGroupResp (6 properties), ConversationMessage (5 properties). Each schema is shown below with its type and property counts.

CreateConversationRequest
object
2 properties
ValidationError
object
3 properties 3 required
InsightTemplateGroupUpdateReq
object
3 properties
InsightTemplateUpdateReq
object
4 properties
Meta
object
4 properties 4 required
ConversationsListData
object
1 property 1 required
GetInsightTemplateGroupsRespData
object
2 properties 2 required
HTTPValidationError
object
1 property
ConversationInsightListData
object
2 properties 2 required
InsightTemplateGroupDetailRespData
object
1 property 1 required
TemplateType
string
ConversationMessage
object
5 properties 2 required
CreateMsgReq
object
8 properties 1 required
InsightTemplateCreateReq
object
4 properties 2 required
InsightTemplateGroupResp
object
6 properties 3 required
InsightTemplateGroupCreateReq
object
3 properties 1 required
ConversationMessageListData
object
2 properties 2 required
Conversation
object
5 properties 4 required
GetInsightTemplatesRespData
object
2 properties 2 required
InsightTemplateDetailRespData
object
1 property 1 required
InsightTemplateResp
object
7 properties 3 required
ConversationInsight
object
4 properties 4 required
UpdateConversationRequest
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

telnyx-conversations-api-openapi.yml Raw ↑

Other APIs Telnyx publishes across the network.

Telnyx Access Tokens API
AE Profile APIs.io
Telnyx Addresses API
AE Profile APIs.io
Telnyx Advanced Number Orders API
AE Profile APIs.io
Telnyx Assistants API
AE Profile APIs.io
Telnyx Audio API
AE Profile APIs.io
Telnyx Audit Logs API
AE Profile APIs.io
Telnyx Authentication Providers API
AE Profile APIs.io
Telnyx AutoRechargePreferences API
AE Profile APIs.io
Telnyx Billing API
AE Profile APIs.io
Telnyx Billing Groups API
AE Profile APIs.io
Telnyx Brands API
AE Profile APIs.io
Telnyx Bucket SSL Certificate API
AE Profile APIs.io
#Conversations
← Back to T APIs
API Details
ID
telnyx:telnyx-conversations-api
Base URL
https://api.telnyx.com/v2
Docs
https://developers.telnyx.com/api
Provider
Telnyx
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network