v1

latestOpenAPI 3.0.22026-07-174617345.8 KB

Conversations

Create a new conversation.

Create a new conversation for an agent (formerly known as project) identified by its unique projectId. This endpoint allows you to initiate a new conversation within a specific agent. A conversation serves as a platform for users to exchange messages regarding agent-related matters. By providing the projectId, you can establish a conversation within the context of the agent allowing you to seamlessly communicate with it. Here is an example to create a conversation: API SDK.

post/api/v1/projects/{projectId}/conversations

Path parameters

projectIdinteger required

The unique identifier of the agent (formerly known as project).

Request body

namestring

Conversation name

Example request

{
  "name": "My conversation"
}

Response

Create a new conversation

status'error' | 'success'

The status of the response

Example response

{
  "status": "success",
  "data": {
    "created_at": "2023-04-30 16:43:53",
    "updated_at": "2023-04-30 16:43:53",
    "deleted_at": "2023-04-30 16:43:53",
    "id": 1,
    "name": "Conversation 1",
    "session_id": "f1b9aaf0-5e4e-11eb-ae93-0242ac130002"
  }
}