Посмотреть настройки базы знаний

Общие сведения о базе: как она называется и как устроена. Нужен в начале, до работы со страницами.

Scope

knowledge:read

Заголовки

• Content-Type: application/json
• X-Api-Key — ключ проекта

Посмотреть настройки базы знаний

POST /v1/ai-knowledge/space/get. Scope knowledge:read.

Учебный пример магазина «Северная полка». Это не запись из вашей базы. Здесь база знаний: запрос и ответ на одном вызове.

Запрос

{
  "data": {
    "projectId": "11111111-1111-4111-8111-111111111111",
    "id": "11111111-1111-4111-8111-111111111111"
  }
}

Ответ (успех, 200)

{
  "success": true,
  "data": {
    "projectId": "11111111-1111-4111-8111-111111111111",
    "name": "База магазина",
    "pageCount": 12
  }
}

Пример cURL

curl -X POST "https://api-external.brifly.online/v1/ai-knowledge/space/get" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: {{api_key}}" \
  -d '{"data": {"projectId": "11111111-1111-4111-8111-111111111111", "id": "11111111-1111-4111-8111-111111111111"}}'

Ошибки

• 401 INVALID_API_KEY
• 403 FORBIDDEN_SCOPE — у ключа нет knowledge:read.
• 403 PROJECT_MISMATCH

См. также

• С чего начать работу с API