SidetalkGuides
Sidetalk website ↗Open dashboard

Training Data Query API

Purpose

Lists training questions and answers saved for the site. Filter by category, a specific knowledgeId, search term, or page.

URL

Plain Text
https://api.sidetalk.ai/v1/knowledge/data

HTTP method

Plain Text
GET

Query parameters

ParameterTypeRequiredDefaultDescription
categoryIdStringNo-Filter by category ID.
knowledgeIdStringNo-Retrieve a specific entry by its training data identifier. Use this value unchanged as knowledgeId in the Answer Generation API.
searchStringNo-Search for a string in the question or answer.
pageIntegerNo1The page number.
limitIntegerNo20Items per page, up to 100.

Example request

Bash
curl "https://api.sidetalk.ai/v1/knowledge/data?categoryId=1&page=1&limit=20" \
  -H "Authorization: Bearer ${API_KEY}"
Use --data-urlencode only when passing values containing Korean characters, spaces, or special characters, such as search terms.
Bash
curl -G "https://api.sidetalk.ai/v1/knowledge/data" \
  -H "Authorization: Bearer ${API_KEY}" \
  --data-urlencode "search=배송"

Success response (200 OK)

JSON
{
  "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
  }
}

Response fields


FieldTypeDescription
successBooleanWhether the request succeeded.
dataArrayThe list of training questions and answers.
data.site_idIntegerThe site ID.
data.categoryIdIntegerThe category ID.
data.questionStringThe saved question.
data.answerStringThe saved answer.
data.referenceUrlString/nullThe linked reference URL.
data.knowledgeIdIntegerThe training data identifier. Pass it as knowledgeId to the Answer Generation API.
data.createdAtStringCreation date and time.
data.updatedAtStringModification date and time.
meta.totalCountIntegerTotal search results.
meta.totalPagesIntegerThe total number of pages.
meta.pageIntegerThe current page number.
meta.limitIntegerItems per page.

Error response

JSON
{
  "success": false,
  "error": "Failed to fetch knowledge data"
}
Status codeDescription
400Invalid query parameters.
403API key authentication failed.
500A server error occurred while retrieving data.