목적

이 API는 사용자 메시지를 전달하고, AI의 응답을 반환합니다. 응답은 일반 JSON 또는 스트림(SSE, Server-Sent Events) 방식으로 받을 수 있습니다.

또한 응답에 포함되는 chat_log_uuid를 이용해, 해당 대화에 대해 도움이 됐어요 / 도움이 안 됐어요 피드백을 저장할 수 있습니다.

URL

<aside> 💡

https://api.sidetalk.ai/v1/chat/completions

</aside>

HTTP 메서드

POST

헤더

헤더 값 설명
Content-Type application/json 요청 본문이 JSON 형식임을 나타냅니다.
Authorization Bearer <api_key> Sidetalk 대시보드에서 설치하기 메뉴에 제공된 API 키를 사용하세요.

본문

파라미터 타입 필수 설명
message String 예 사용자 메시지입니다.
stream Boolean 아니요 응답을 스트림으로 받을지 여부를 지정합니다. true 또는 false. 지정하지 않으면 기본값 false가 사용됩니다.
sessionId String 아니요 대화 세션을 구분하는 고유 키(Key)입니다. 이전 대화 내용을 기억하여 대화를 이어가려면 동일한 값을 유지해야 합니다.
memberId String 아니요 고객을 구분하는 회원 고유 ID입니다. 대화 로그를 특정 고객과 연결하려면 전달합니다. 동일한 고객의 대화를 추적하려면 항상 같은 값을 사용하세요.

요청 예시

curl -X POST <https://api.sidetalk.ai/v1/chat/completions> \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${API_KEY}" \
  -d '{
    "message": "안녕하세요, 도움이 필요해요.",
    "stream": false,
    "sessionId": "test-session-id",
    "memberId": "user_123"
  }'

응답 형식