# Огляд API та базовий URL SUMMARY: Усі кінцеві точки API Synapse, базовий URL, шаблони автентифікації та формати відповідей у стислому вигляді. KEY CONTEXT: Base URL: https://synapse.schaefer.zone Auth: Authorization: Bearer YOUR_MIND_KEY (header, no rate limit) OR ?key=YOUR_MIND_KEY (query, 60 req/min) All responses are JSON except /memory/recall (text/plain) and /docs (HTML/text/json) All 404 responses mean the path does not exist — do NOT guess paths. GET /endpoints returns machine-readable list of all valid endpoints. Огляд API та базовий URL API Synapse — це RESTful HTTP API. Усі кінцеві точки повертають JSON (окрім випадків, де зазначено інше). Ця сторінка охоплює основи, які потрібно знати перед вивченням конкретних кінцевих точок. Базовий URL [CODE BLOCK] Усі шляхи у цій документації вказуються відносно цього базового URL. Для власних інсталяцій замініть на ваш URL. Автентифікація Два методи, обидва передаються через заголовок : [CODE BLOCK] Або через параметр запиту (з обмеженням частоти 60/хв): [CODE BLOCK] Докладніше дивіться у Автентифікації. Групи кінцевих точок | Група | Автентифікація | Опис | |-------|------|-------------| | Public | Немає | Головна сторінка, перевірка стану, OpenAPI, документація | | Memory | Mind Key | CRUD, пошук, синхронізація, ембеддинги | | Chat | Mind Key / JWT | Асинхронне спілкування між людиною та агентом | | Tasks | Mind Key | Керування завданнями | | Scripts | Mind Key / JWT | Постійне сховище скриптів | | Scheduler | Mind Key | Cron-завдання + змінні | | Webhooks | Mind Key | HTTP-зворотні виклики подій | | Computers | Mind Key / JWT | Віддалене керування комп'ютерами | | User/Minds | JWT | Обліковий запис + керування mind-ами | | Sharing | JWT | Спільний доступ до mind-ів між користувачами | | Push | JWT | Підписки Web Push | | Tools | Немає | Час, калькулятор, випадкові значення (публічні утиліти) | Формати відповідей - JSON (за замовчуванням): - Звичайний текст: повертає текст, оптимізований для LLM - HTML: , , , , Стандартна обгортка відповіді Успішні відповіді повертають дані безпосередньо: [CODE BLOCK] Відповіді з помилками використовують такий формат: [CODE BLOCK] > [!NOTE] > Поле містить посилання на відповідну документацію для поширених помилок. Коди стану HTTP | Код | Значення | |------|---------| | 200 | Успіх (GET, PUT) | | 201 | Створено (POST) | | 204 | Немає вмісту (DELETE) | | 400 | Некоректний запит (помилка валідації) | | 401 | Не автентифіковано (відсутній/недійсний токен) | | 403 | Заборонено (неправильний тип токена) | | 404 | Не знайдено (шлях не існує) | | 409 | Конфлікт (дублікат) | | 429 | Забагато запитів (обмеження частоти) | | 500 | Помилка сервера | Кінцеві точки для виявлення | Кінцева точка | Призначення | |----------|---------| | | Головна сторінка (оптимізована для LLM) | | | Машиночитний список усіх кінцевих точок | | | Список кінцевих точок у вигляді звичайного тексту | | | Специфікація OpenAPI 3.0 | | | Повна документація API (HTML) | | | Документація API у форматі JSON | | | Система документації (HTML) | | | Індекс документації (JSON) | | | Уся документація одним текстовим блоком | | | Інтерактивний playground API | Обмеження частоти | Метод автентифікації | Ліміт | |-------------|-------| | Mind Key (заголовок) | Немає | | Mind Key (?key=) | 60/хв на IP | | JWT (заголовок) | Немає | | Публічні кінцеві точки | Немає | Відповіді з обмеженням частоти містять: [CODE BLOCK] Пагінація Кінцеві точки списків підтримують та : [CODE BLOCK] Ліміт за замовчуванням: 100. Максимальний ліміт: 500. CORS Усі кінцеві точки підтримують CORS для браузерних клієнтів: [CODE BLOCK] SDK та клієнти - Node.js SDK: (репозиторій) - MCP Server: (репозиторій) - HTTP-клієнт: будь-яка HTTP-бібліотека (curl, fetch, axios тощо) Наступні кроки - Memory API — найважливіші кінцеві точки - Chat API — асинхронне спілкування людина-агент - Помилки та обробка помилок