Посмотреть памятку магазина для ИИ

Текст, который ИИ читает про ваш магазин: кто клиент, чем торгуете, как говорите. Нужен, чтобы проверить, не устарела ли эта памятка.

Scope

catalog:read

Заголовки

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

Посмотреть памятку магазина для ИИ

POST /v1/catalog-client-ai-context/get. Scope catalog:read.

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

Запрос

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

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

{
  "success": true,
  "data": {
    "projectId": "11111111-1111-4111-8111-111111111111",
    "text": "Магазин посуды для похода. Говорим коротко, без скидочного крика."
  }
}

Пример cURL

curl -X POST "https://api-external.brifly.online/v1/catalog-client-ai-context/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 — у ключа нет catalog:read.
403 PROJECT_MISMATCH — в теле другой проект.
429 RATE_LIMIT_EXCEEDED — заголовок Retry-After.
400 VALIDATION_ERROR — не хватает поля в data.

Ограничения

Проект и пользователь берутся из ключа. Чужой data.projectId отвечает 403 PROJECT_MISMATCH.

Scope

Заголовки

Посмотреть памятку магазина для ИИ

Запрос

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

Пример cURL

Ошибки

Ограничения

См. также