Create Chat Thread

POST

/v2/api/agent/{agent_id}/chat-thread

Overview

This endpoint allows clients to initiate a new chat thread linked to a specific agent. The created chat thread can later be used to maintain a conversation context, enabling better interaction history and traceability for future reference.

Functionality

Agent Identification:

Requires a valid agent_id as a path parameter.

Ensures that the chat thread is associated with the correct agent entity in the system.

How to Find Your Agent ID

If you're unsure about the agent_id, follow this guide:
How to View Agent ID

Operation Result:

On success, returns a 201 Created response with:

Unique id of the created chat thread.

Metadata including created_by, created_on, and optional fields like corpus_id and chat_id.

Status flags such as is_deleted.

Associated agent and user IDs.

Optional title of the chat thread for identification.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https:///v2/api/agent/0/chat-thread' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

201 - Example 1

{
    "success": true,
    "message": "Chat Thread created successfully.",
    "data": {
        "id": 1002,
        "corpus_id": null,
        "created_by": "user@example.com",
        "created_on": "2025-01-24T22:55:14.774136Z",
        "modified_by": "",
        "modified_on": "2025-01-24T22:55:14.774166Z",
        "title": "Sample Thread Title",
        "is_deleted": false,
        "chat_id": null,
        "agent": 101,
        "user": 500
    }
}

Request

Path Params

Header Params

Responses

🟢201Created

application/json

Chat thread created successfully.

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Edit Agent Comment

Get All Chat Threads Of An Agent

Create Chat Thread

Overview#

Functionality#

How to Find Your Agent ID#

Request

Responses

Overview

Functionality

How to Find Your Agent ID