Create Chat Thread for an Agent

POST

/api/v2/agents/{agent_id}/chat-threads

This endpoint is used to create a chat thread for an agent. It defaults to creating a chat thread with a title "New Thread" if no title is provided.

Staging behaviour:

Pass agent_version=staging as a query parameter to create the chat thread for the staging version instead of the published agent.

Path Parameters:

agent_id: ID of the agent for which the chat thread is to be created

Request Body:

title (str): Title of the chat thread

Returns:

A JSON response with the created chat thread object or error message.

Current Version:

2.0.0

Request

Path Params

Header Params

Body Params

application/json

Examples

Responses

🟢201Created

application/json

Chat thread created successfully

Bodyapplication/json

🟠400Bad Request

🟠403Record Not Found

🟠404Server Error

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/agents//chat-threads' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
    "title": "string"
}'

Response Example

201 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "id": 0,
        "created_by": "string",
        "modified_by": "string",
        "created_on": "2019-08-24T14:15:22.123Z",
        "modified_on": "2019-08-24T14:15:22.123Z",
        "corpus_id": 0,
        "title": "string",
        "is_deleted": true,
        "chat_id": "string",
        "is_system_created": true,
        "parent": 0,
        "agent": 0,
        "user": 0
    }
}

Get Chat Threads of an Agent

Agent Comment