Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
metadata
object

Metadata associated with the conversation. Set ai_disabled to true to create the conversation with AI message responses disabled.

Response

Successful Response

id
string<uuid>
required
Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

created_at
string<date-time>
required

The datetime the conversation was created.

Example:

"2025-04-15T13:07:28.764Z"

metadata
object
required

Metadata associated with the conversation. Telnyx provides several pieces of metadata, but customers can also add their own. The reserved field ai_disabled (boolean) can be set to true to prevent AI-generated responses on this conversation. When ai_disabled is true, calls to the chat endpoint will return a 400 error. Set to false or remove the field to re-enable AI responses. This is useful when a human agent needs to take over the conversation mid-stream (e.g., a technician stepping in while AI was messaging a resident).

Example:
last_message_at
string<date-time>
required

The datetime of the latest message in the conversation.

Example:

"2025-04-15T13:07:28.764Z"

name
string
Example:

""