학습용 데이터 입력 API

4 분 읽기가이드 기준일: 2026. 10. 14.노션 원문 보기 ↗

목적

이 API는 지정된 카테고리 ID와 함께 질문 및 답변 데이터를 Sidetalk에 저장합니다.

URL

HTTP 메서드

POST

헤더

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

본문

파라미터	타입	필수	설명
categoryId	String	아니요	질문과 답변이 속하는 카테고리의 ID. Sidetalk 대시보드에서 AI 카테고리 관리 에서 카테고리를 관리 할 수있습니다.
question	String	예	사용자 질문입니다. 하나의 질문을 문자열로 전달합니다.
answer	String	예	질문에 대한 답변입니다.

요청 예시

Bash

curl -X POST https://api.sidetalk.ai/v1/knowledge/qna \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ${API_KEY}" \
  -d '{
      "categoryId": "1",
      "question": "안녕하세요, 도움이 필요해요.",
      "answer": "안녕하세요! 무엇을 도와드릴까요?"
  }'

응답 형식

성공 응답(200 OK)

요청이 성공적으로 처리되어 질문과 답변 데이터가 저장되었을 때, 다음과 같은 응답이 반환됩니다.

응답 본문

JSON

{
  "success": true,
  "data": {
    "site_id": //해당 site_id,
    "categoryId": "1",
    "question": "안녕하세요, 도움이 필요해요.",
    "answer": "안녕하세요! 무엇을 도와드릴까요?",
    "created_at": "20241108120639",
  },
  "message": "Data has been successfully saved."
}

응답 필드 설명

필드	타입	설명
success	boolean	요청이 성공했음을 나타내며, 항상 `true`입니다.
data	object	저장된 데이터 정보를 담고 있습니다.
data.site_id	integer	요청에 사용된 사이트 ID입니다.
data.categoryId	string	저장된 질문과 답변이 속한 카테고리 ID입니다.
data.question	string	저장된 질문입니다.
data.answer	string	저장된 답변입니다.
data.created_at	string	데이터가 저장된 시간입니다.
message	string	요청이 성공했음을 나타내는 메시지입니다.

오류 응답(500 Internal Server Error)

서버 오류나 요청 처리 중 문제가 발생한 경우, 다음과 같은 응답이 반환됩니다.

응답 본문

JSON

{
  "success": false,
  "error": "오류 메시지 내용"
}

오류 응답 필드 설명

필드	타입	설명
success	boolean	요청이 실패했음을 나타내며, 항상 `false`입니다.
error	string	발생한 오류 메시지의 내용을 포함하여 문제의 원인을 제공합니다.