목적

사이트에 저장된 학습용 질문·답변 데이터를 목록으로 조회합니다. 카테고리, 특정 knowledgeId, 검색어, 페이지 단위로 필터링할 수 있습니다.

URL

<https://api.sidetalk.ai/v1/knowledge/data>

HTTP 메서드

GET

쿼리 파라미터

파라미터 타입 필수 기본값 설명
categoryId String 아니요 - 카테고리 ID로 필터링합니다.
knowledgeId String 아니요 - 학습용 데이터 식별자로 특정 데이터를 조회합니다. 이 값을 답변 생성 API의 knowledgeId에 그대로 사용할 수 있습니다.
search String 아니요 - 질문 또는 답변에 포함된 문자열로 검색합니다.
page Integer 아니요 1 페이지 번호입니다.
limit Integer 아니요 20 페이지당 조회 개수입니다. 최대 100개입니다.

요청 예시

curl "<https://api.sidetalk.ai/v1/knowledge/data?categoryId=1&page=1&limit=20>" \
  -H "Authorization: Bearer ${API_KEY}"

검색어처럼 한글·공백·특수문자가 포함된 값을 전달할 때만 --data-urlencode를 사용할 수 있습니다.

curl -G "<https://api.sidetalk.ai/v1/knowledge/data>" \
  -H "Authorization: Bearer ${API_KEY}" \
  --data-urlencode "search=배송"

성공 응답(200 OK)

{
  "success": true,
  "data": [
    {
      "site_id": "15",
      "categoryId": "1",
      "question": "배송 기간이 어떻게 되나요?",
      "answer": "결제 후 2~3일 이내에 배송됩니다.",
      "referenceUrl": null,
      "knowledgeId": "456",
      "createdAt": "20241108120639",
      "updatedAt": "20241108120639"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "totalCount": 1,
    "totalPages": 1
  }
}

응답 필드

필드 타입 설명
success Boolean 요청 성공 여부입니다.
data Array 학습용 질문·답변 데이터 목록입니다.
data.site_id Integer 사이트 ID입니다.
data.categoryId Integer 카테고리 ID입니다.
data.question String 저장된 질문입니다.
data.answer String 저장된 답변입니다.
data.referenceUrl String/null 연결된 참고 URL입니다.
data.knowledgeId Integer 학습용 데이터 식별자입니다. 답변 생성 API의 knowledgeId에 전달합니다.
data.createdAt String 생성 일시입니다.
data.updatedAt String 수정 일시입니다.
meta.totalCount Integer 전체 검색 결과 개수입니다.
meta.totalPages Integer 전체 페이지 수입니다.
meta.page Integer 현재 페이지 번호입니다.
meta.limit Integer 페이지당 조회 개수입니다.

오류 응답

{
  "success": false,
  "error": "Failed to fetch knowledge data"
}
상태 코드 설명
400 쿼리 파라미터가 잘못되었습니다.
403 API 키 인증에 실패했습니다.
500 데이터 조회 중 서버 오류가 발생했습니다.