Wersja dla AI (llms.txt)

ProxyHat publikuje kopie tej dokumentacji w formacie czytelnym dla maszyn, dzięki czemu asystenci AI mogą czytać API i rozumieć je bezpośrednio. Jeśli budujesz integrację z pomocą Claude, Cursor, Codex lub innego narzędzia opartego na LLM, przekaż mu te pliki — otrzyma pełny, dokładny obraz API bez zgadywania.

Daj swojemu AI całe API

Jedno kliknięcie kopiuje kompletną dokumentację wraz z krótkim wprowadzeniem, które mówi asystentowi, jak z niej korzystać — to jak instalacja nowej umiejętności. Wklej całość w nowym czacie, a AI będzie znać całe API ProxyHat.

Działa z Claude, ChatGPT, Cursor, Codex, Gemini i każdym innym asystentem.

Dwa artefakty, jedna konwencja. ProxyHat stosuje konwencję llmstxt.org. /llms.txt to zwięzły, starannie dobrany indeks linków do wszystkich stron dokumentacji. /llms-full.txt to cała dokumentacja spłaszczona do jednego, samodzielnego pliku Markdown — wszystko, czego potrzebuje asystent, w jednym wklejeniu.

Dwa pliki

Indeks linków — krótki plik Markdown z listą wszystkich stron dokumentacji, każda z jednozdaniowym opisem i adresem URL. Na tyle mały, że można go trzymać w kontekście asystenta na stałe; poszczególne strony model pobiera na żądanie.

https://docs.proxyhat.com/llms.txt

Pełna dokumentacja — wszystkie strony połączone w jeden dokument Markdown. Żadnych linków do klikania, żadnego pobierania: wklej go raz, a asystent zna całe API.

https://docs.proxyhat.com/llms-full.txt

Jak użyć tego w swoim narzędziu

Wszędzie sprawdzają się dwa podejścia:

Wklej. Kliknij „Kopiuj dla AI” powyżej (lub otwórz https://docs.proxyhat.com/llms-full.txt i skopiuj cały plik), a następnie wklej go do czatu asystenta albo do pliku z kontekstem lub regułami. Najlepsze, gdy Twoje narzędzie nie ma dostępu do internetu.
Wskaż URL. Podaj narzędziu adres https://docs.proxyhat.com/llms.txt lub https://docs.proxyhat.com/llms-full.txt i pozwól mu go pobrać. Najlepsze dla narzędzi z dostępem do sieci lub możliwością pobierania plików.

Uwagi dla poszczególnych narzędzi

Claude / Claude Code — wklej zawartość llms-full.txt do rozmowy albo dodaj URL do pliku CLAUDE.md w swoim projekcie, aby każda sesja miała go pod ręką. Claude Code może też pobrać URL bezpośrednio swoimi narzędziami sieciowymi.
Codex — umieść URL lub wklejoną zawartość w swoim AGENTS.md (albo w prompcie), aby agent sięgał do niej podczas pisania Twojej integracji.
Cursor — dodaj https://docs.proxyhat.com/llms-full.txt w Settings → Indexing & Docs (Add new doc) albo wklej plik do .cursorrules / reguły projektu.
Kimi — wklej zawartość llms-full.txt do czatu albo udostępnij URL i poproś, aby najpierw przeczytał plik.
OpenCode — wskaż URL w konfiguracji agenta / pliku reguł albo wklej cały plik do kontekstu.
Dowolny inny LLM — zasada jest ta sama: użyj przycisku „Kopiuj dla AI”, wklej zawartość llms-full.txt do swojego asystenta lub wskaż narzędziu powyższe adresy URL.

Czego nauczy się AI

Z tych plików asystent dowie się wszystkiego, czego potrzebuje, aby napisać działającą integrację, w tym:

Bazowy URL — każde żądanie trafia na https://api.proxyhat.com/v1.
Uwierzytelnianie — jak uzyskać klucz API i przesyłać go jako Authorization: Bearer <key>.
Model subużytkowników — jak subużytkownicy, grupy i presety przekładają się na dostęp do proxy.
Ciągi połączeniowe proxy — gramatyka nazwy użytkownika (kraj, sesja, rotacja i targetowanie filtrem AI) oraz sposób budowania lub pobierania gotowego do użycia ciągu połączeniowego.
Przepływ resellerski — tworzenie proxy i zarządzanie nimi w imieniu własnych klientów.
Struktury odpowiedzi — które endpointy używają standardowej koperty {success, payload, meta, errors, description}, a które zwracają płaskie obiekty — wszędzie z prawdziwymi nazwami pól.

Zawsze aktualne. Oba pliki są generowane z tego samego źródła co strony, które właśnie czytasz, więc korzystający z nich asystent pozostaje zsynchronizowany z działającym API. W razie wątpliwości wybieraj llms-full.txt — jest kompletny i samodzielny.