Conversations

Conversation related APIs

목록 대화 가져오기

get
/webapi/v2/conversations

대화 목록을 가져옵니다. 대화는 기본적으로 마지막 대화 시간 기준으로 내림차순으로 정렬됩니다.

Authorizations
API-KEYstringRequired

Required: Your API key for authentication

Query parameters
userIdsany ofOptional
or
nullOptional
llmAppIdany ofOptional
stringOptional
or
nullOptional
categoryIdany ofOptional
stringOptional
or
nullOptional
startedAtany ofOptional

Search for last chat time after this value

numberOptional
or
nullOptional
endAtany ofOptional

Search for last chat time before this value

numberOptional
or
nullOptional
firstChatStartedAtany ofOptional

Search for first chat time after this value

numberOptional
or
nullOptional
firstChatEndAtany ofOptional

Search for first chat time before this value

numberOptional
or
nullOptional
searchTermany ofOptional
stringOptional
or
nullOptional
cursorany ofOptional
stringOptional
or
nullOptional
variablesany ofOptional
string[]Optional
or
nullOptional
pageSizeinteger · min: 1 · max: 50OptionalDefault: 50
activeOnlybooleanOptionalDefault: false
orderall ofOptionalDefault: LAST_CHAT_TIME_DESC
string · enumOptionalPossible values:
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

알겠습니다

application/json
get
/webapi/v2/conversations
GET /webapi/v2/conversations HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
200

알겠습니다

{
  "conversations": [
    {
      "id": "text",
      "title": "text",
      "user": {
        "userId": "text",
        "firstName": "text",
        "lastName": "text"
      },
      "createdAt": 1,
      "lastChatTime": 1,
      "isEnd": true,
      "categories": [
        "text"
      ],
      "memo": "text",
      "chats": [
        {
          "id": "text",
          "sender": "USER",
          "message": "text",
          "timestamp": 1,
          "citations": [
            {
              "clueId": "text",
              "source": "text",
              "title": "text",
              "knowledgeBaseId": "text",
              "pageNo": 1,
              "url": "text",
              "text": "text"
            }
          ],
          "rating": true,
          "agentRating": true
        }
      ],
      "chatCount": 1,
      "llmApp": {
        "id": "text",
        "name": "text",
        "description": "text"
      },
      "variables": {}
    }
  ],
  "cursor": "text"
}

대화 설정

post
/webapi/v2/conversations/bulk_update
Authorizations
API-KEYstringRequired

Required: Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
userIdsany ofOptional

필터링을 위한 유저의 ID

string[]Optional
or
nullOptional
llmAppIdsany ofOptional

필터링을 위한 llm 앱의 ID

string[]Optional
or
nullOptional
categoryIdsany ofOptional

필터링을 위한 대화 카테고리의 ID

string[]Optional
or
nullOptional
conversationIdsany ofOptional

필터링을 위한 대화 ID

string[]Optional
or
nullOptional
Responses
200

알겠습니다

No content

post
/webapi/v2/conversations/bulk_update
POST /webapi/v2/conversations/bulk_update HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "userIds": [
    "text"
  ],
  "llmAppIds": [
    "text"
  ],
  "categoryIds": [
    "text"
  ],
  "conversationIds": [
    "text"
  ],
  "conversationInfo": {
    "state": "no",
    "assignee": "text",
    "categoryIds": [
      "text"
    ],
    "title": "text"
  }
}
200

알겠습니다

No content

ID로 대화 가져오기

get
/webapi/v2/conversations/{conversation_id}

대화를 시작해 주세요.

대화에 제공된 대화은 가장 최근의 20건입니다.

Authorizations
API-KEYstringRequired

Required: Your API key for authentication

Path parameters
conversation_idstringRequired
Query parameters
variablesany ofOptional

Comma separated list of variables to include in the response

string[]Optional
or
nullOptional
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

알겠습니다.

application/json
get
/webapi/v2/conversations/{conversation_id}
GET /webapi/v2/conversations/{conversation_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
200

알겠습니다.

{
  "id": "text",
  "title": "text",
  "user": {
    "userId": "text",
    "firstName": "text",
    "lastName": "text"
  },
  "createdAt": 1,
  "lastChatTime": 1,
  "isEnd": true,
  "categories": [
    "text"
  ],
  "memo": "text",
  "chats": [
    {
      "id": "text",
      "sender": "USER",
      "message": "text",
      "timestamp": 1,
      "citations": [
        {
          "clueId": "text",
          "source": "text",
          "title": "text",
          "knowledgeBaseId": "text",
          "pageNo": 1,
          "url": "text",
          "text": "text"
        }
      ],
      "rating": true,
      "agentRating": true
    }
  ],
  "chatCount": 1,
  "llmApp": {
    "id": "text",
    "name": "text",
    "description": "text"
  },
  "variables": {}
}

대화 설정

patch
/webapi/v2/conversations/{conversation_id}
Authorizations
API-KEYstringRequired

Required: Your API key for authentication

Path parameters
conversation_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
stateany ofOptional

대화의 상태

string · enumOptionalPossible values:
or
nullOptional
assigneeany ofOptional

대화의 담당자

stringOptional
or
nullOptional
categoryIdsany ofOptional

카테고리의 ID

string[]Optional
or
nullOptional
titleany ofOptional

대화의 제목

stringOptional
or
nullOptional
Responses
200

알겠습니다.

application/json
patch
/webapi/v2/conversations/{conversation_id}
PATCH /webapi/v2/conversations/{conversation_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "state": "no",
  "assignee": "text",
  "categoryIds": [
    "text"
  ],
  "title": "text"
}
200

알겠습니다.

{
  "id": "text",
  "title": "text",
  "user": {
    "userId": "text",
    "firstName": "text",
    "lastName": "text"
  },
  "createdAt": 1,
  "lastChatTime": 1,
  "isEnd": true,
  "categories": [
    "text"
  ],
  "memo": "text",
  "chats": [
    {
      "id": "text",
      "sender": "USER",
      "message": "text",
      "timestamp": 1,
      "citations": [
        {
          "clueId": "text",
          "source": "text",
          "title": "text",
          "knowledgeBaseId": "text",
          "pageNo": 1,
          "url": "text",
          "text": "text"
        }
      ],
      "rating": true,
      "agentRating": true
    }
  ],
  "chatCount": 1,
  "llmApp": {
    "id": "text",
    "name": "text",
    "description": "text"
  },
  "variables": {}
}

대화 목록 대화

get
/webapi/v2/conversations/{conversation_id}/chats

대화 대화을 가져오세요. 대화은 타임스탬프를 기준으로 오름차순으로 정렬됩니다.

대화 페이지 크기는 100입니다.

Authorizations
API-KEYstringRequired

Required: Your API key for authentication

Path parameters
conversation_idstringRequired
Query parameters
pageNointeger · min: 1OptionalDefault: 1
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

좋아

application/json
get
/webapi/v2/conversations/{conversation_id}/chats
GET /webapi/v2/conversations/{conversation_id}/chats HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
200

좋아

{
  "chats": [
    {
      "id": "text",
      "sender": "USER",
      "message": "text",
      "timestamp": 1,
      "citations": [
        {
          "clueId": "text",
          "source": "text",
          "title": "text",
          "knowledgeBaseId": "text",
          "pageNo": 1,
          "url": "text",
          "text": "text"
        }
      ],
      "rating": true,
      "agentRating": true
    }
  ],
  "pageNo": 1,
  "totalCount": 1
}

ID로 대화 상태 가져오기

get
/webapi/v2/conversations/{conversation_id}/running
Authorizations
API-KEYstringRequired

Required: Your API key for authentication

Path parameters
conversation_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

알겠습니다

application/json
get
/webapi/v2/conversations/{conversation_id}/running
GET /webapi/v2/conversations/{conversation_id}/running HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
200

알겠습니다

{
  "isRunning": true
}

Stop Conversation

post
/webapi/v2/conversations/{conversation_id}/stop

Stop a running conversation.

Authorizations
API-KEYstringRequired

Required: Your API key for authentication

Path parameters
conversation_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

OK

No content

post
/webapi/v2/conversations/{conversation_id}/stop
POST /webapi/v2/conversations/{conversation_id}/stop HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
200

OK

No content

아이디로 대화 대화 삭제

delete
/webapi/v2/conversations/{conversation_id}/chats/{chat_id}
Authorizations
API-KEYstringRequired

Required: Your API key for authentication

Path parameters
conversation_idstringRequired
chat_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Responses
200

알겠습니다.

No content

delete
/webapi/v2/conversations/{conversation_id}/chats/{chat_id}
DELETE /webapi/v2/conversations/{conversation_id}/chats/{chat_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*
200

알겠습니다.

No content

대화 제목 업데이트

put
/webapi/v2/conversations/{conversation_id}/title

대화 제목 설정.

Authorizations
API-KEYstringRequired

Required: Your API key for authentication

Path parameters
conversation_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
titlestringRequired

대화의 제목

Responses
200

알겠습니다

application/json
put
/webapi/v2/conversations/{conversation_id}/title
PUT /webapi/v2/conversations/{conversation_id}/title HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "title": "text"
}
200

알겠습니다

{
  "id": "text",
  "title": "text",
  "user": {
    "userId": "text",
    "firstName": "text",
    "lastName": "text"
  },
  "createdAt": 1,
  "lastChatTime": 1,
  "isEnd": true,
  "categories": [
    "text"
  ],
  "memo": "text",
  "chats": [
    {
      "id": "text",
      "sender": "USER",
      "message": "text",
      "timestamp": 1,
      "citations": [
        {
          "clueId": "text",
          "source": "text",
          "title": "text",
          "knowledgeBaseId": "text",
          "pageNo": 1,
          "url": "text",
          "text": "text"
        }
      ],
      "rating": true,
      "agentRating": true
    }
  ],
  "chatCount": 1,
  "llmApp": {
    "id": "text",
    "name": "text",
    "description": "text"
  },
  "variables": {}
}

피드백 게시하기

post
/webapi/v2/conversations/{conversation_id}/chats/{chat_id}/feedback
Authorizations
API-KEYstringRequired

Required: Your API key for authentication

Path parameters
conversation_idstringRequired
chat_idstringRequired
Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
ratingany ofOptional

대화에 대한 평가

booleanOptional
or
nullOptional
feedbackSelectionany ofOptional

피드백 선택

or
nullOptional
suggestedAnswerany ofOptional

제안된 답변

stringOptional
or
nullOptional
Responses
200

알겠습니다.

application/json
post
/webapi/v2/conversations/{conversation_id}/chats/{chat_id}/feedback
POST /webapi/v2/conversations/{conversation_id}/chats/{chat_id}/feedback HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 77

{
  "rating": true,
  "feedbackSelection": [
    "not_relevant"
  ],
  "suggestedAnswer": "text"
}
200

알겠습니다.

{
  "conversationId": "text",
  "chatId": "text",
  "rating": true
}

일일 대화 횟수

get
/webapi/conversation_daily_count

주어진 범위에 대한 하루 총 대화 수.

Authorizations
API-KEYstringRequired

Required: Your API key for authentication

Header parameters
AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body
startDatestringOptional

YYYY-MM-DD 형식으로 조회할 날짜 범위의 시작.

endDatestringOptional

조회할 날짜 범위의 끝(YYYY-MM-DD 형식).

Responses
200

성공적으로 검색된 일일 대화 횟수

application/json
get
/webapi/conversation_daily_count
GET /webapi/conversation_daily_count HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "startDate": "text",
  "endDate": "text"
}
200

성공적으로 검색된 일일 대화 횟수

{
  "result": {
    "dailyTotalCount": [
      {
        "date": "text",
        "activeCount": 1
      }
    ],
    "state": "text",
    "campaignCount": 1
  },
  "errors": {}
}

Last updated

Was this helpful?