# Przegląd API i bazowy URL SUMMARY: Wszystkie endpointy API Synapse, bazowy URL, wzorce autoryzacji i formaty odpowiedzi w jednym miejscu. 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. Przegląd API i bazowy URL API Synapse jest RESTfulowym interfejsem HTTP. Wszystkie endpointy zwracają JSON (z wyjątkiem miejsc, w których zaznaczono inaczej). Niniejsza strona zawiera podstawowe informacje potrzebne przed przejściem do szczegółowych endpointów. Bazowy URL [CODE BLOCK] Wszystkie ścieżki w niniejszej dokumentacji są względne wobec tego bazowego URL-a. W przypadku instancji self-hosted należy użyć własnego adresu URL. Autoryzacja Dwie metody, obie wysyłane nagłówkiem : [CODE BLOCK] Lub przez parametr zapytania (ograniczony do 60/min): [CODE BLOCK] Szczegóły znajdują się w sekcji Autoryzacja. Grupy endpointów | Grupa | Autoryzacja | Opis | |-------|-------------|------| | Publiczne | Brak | Strona główna, health, OpenAPI, dokumentacja | | Memory | Mind Key | CRUD, wyszukiwanie, synchronizacja, osadzenia | | Chat | Mind Key / JWT | Asynchroniczne wiadomości między człowiekiem a agentem | | Tasks | Mind Key | Zarządzanie zadaniami | | Scripts | Mind Key / JWT | Trwały magazyn skryptów | | Scheduler | Mind Key | Zadania cron i zmienne | | Webhooks | Mind Key | Wywołania zwrotne HTTP przy zdarzeniach | | Computers | Mind Key / JWT | Zdalne sterowanie komputerami | | User/Minds | JWT | Konto i zarządzanie umysłami | | Sharing | JWT | Współdzielenie umysłów między użytkownikami | | Push | JWT | Subskrypcje Web Push | | Tools | Brak | Czas, kalkulator, losowość (narzędzia publiczne) | Formaty odpowiedzi - JSON (domyślnie): - Zwykły tekst: zwraca tekst zoptymalizowany dla LLM - HTML: , , , , Standardowa koperta odpowiedzi Odpowiedzi pomyślne zwracają dane bezpośrednio: [CODE BLOCK] Odpowiedzi błędne używają następującego formatu: [CODE BLOCK] > [!NOTE] > Pole zawiera link do dokumentacji istotnej dla częstych błędów. Kody stanu HTTP | Kod | Znaczenie | |------|-----------| | 200 | Sukces (GET, PUT) | | 201 | Utworzono (POST) | | 204 | Brak treści (DELETE) | | 400 | Nieprawidłowe żądanie (błąd walidacji) | | 401 | Brak autoryzacji (brak/nieprawidłowy token) | | 403 | Zabronione (nieprawidłowy typ tokena) | | 404 | Nie znaleziono (ścieżka nie istnieje) | | 409 | Konflikt (duplikat) | | 429 | Zbyt wiele żądań (limit) | | 500 | Błąd serwera | Endpointy wykrywalności | Endpoint | Przeznaczenie | |----------|---------------| | | Strona główna (zoptymalizowana dla LLM) | | | Czytelna maszynowo lista wszystkich endpointów | | | Lista endpointów w postaci zwykłego tekstu | | | Specyfikacja OpenAPI 3.0 | | | Pełna dokumentacja API (HTML) | | | Dokumentacja API jako JSON | | | System dokumentacji (HTML) | | | Indeks dokumentacji (JSON) | | | Cała dokumentacja jako jeden blok tekstowy | | | Interaktywny playground API | Limity żądań | Metoda autoryzacji | Limit | |-------------|-------| | Mind Key (nagłówek) | Brak | | Mind Key (?key=) | 60/min na IP | | JWT (nagłówek) | Brak | | Endpointy publiczne | Brak | Odpowiedzi objęte limitem zawierają: [CODE BLOCK] Paginacja Endpointy list obsługują oraz : [CODE BLOCK] Domyślny limit: 100. Maksymalny limit: 500. CORS Wszystkie endpointy obsługują CORS dla klientów opartych na przeglądarce: [CODE BLOCK] SDK i klienci - Node.js SDK: (repozytorium) - MCP Server: (repozytorium) - Klient HTTP: dowolna biblioteka HTTP (curl, fetch, axios itp.) Następne kroki - Memory API — najważniejsze endpointy - Chat API — asynchroniczna komunikacja człowiek-agent - Błędy i ich obsługa