Dokumentacja

Klucze API

Generuj klucze API i zarządzaj nimi, aby uzyskać programowy dostęp.

Klucze API umożliwiają programowy dostęp do Twoich agentów. Używaj ich, aby zintegrować Agentkit z własnymi aplikacjami lub połączyć usługi zewnętrzne.

Uwaga: klucze API wymagają planu Hobby lub wyższego z aktywnymi rozliczeniami. Obszary robocze na planie Free, z zaległą płatnością lub nieopłacone nie mają dostępu do API. Ulepsz swój plan →

Tworzenie klucza API

  1. Przejdź do swojego obszaru roboczego
  2. Kliknij Klucze API na pasku bocznym
  3. Kliknij Utwórz klucz API
  4. Potwierdź w oknie dialogowym

Nowy klucz pojawi się na liście i w każdej chwili można go odsłonić lub skopiować.

Wyświetlanie i kopiowanie kluczy

Każdy klucz na liście jest domyślnie zamaskowany. Użyj ikony oka, aby odsłonić klucz, oraz ikony kopiowania, aby skopiować go do schowka.

Korzystanie z kluczy API

Dołącz klucz do żądań API:

curl -X POST 'https://your-domain.com/api/v1/chat' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"chatbotId": "uuid", "messages": [{"role": "user", "content": "Hello"}]}'

Pełna dokumentacja API →

Zarządzanie kluczami

Wyświetlanie wszystkich kluczy

Wszystkie klucze danego obszaru roboczego są widoczne na stronie Klucze API.

Usuwanie klucza

  1. Znajdź klucz na liście
  2. Kliknij ikonę kosza
  3. Potwierdź usunięcie

Usunięte klucze przestają działać natychmiast.

Najlepsze praktyki bezpieczeństwa

Nigdy nie ujawniaj kluczy

  • Nie umieszczaj kluczy w commitach repozytoriów git
  • Nie umieszczaj kluczy w kodzie po stronie klienta
  • Korzystaj ze zmiennych środowiskowych

Regularnie rotuj klucze

  • Twórz nowe klucze cyklicznie
  • Aktualizuj swoje aplikacje
  • Usuwaj stare klucze

Używaj oddzielnych kluczy

Twórz osobne klucze dla:

  • Środowiska produkcyjnego i deweloperskiego
  • Różnych aplikacji
  • Różnych członków zespołu lub usług

Zakres uprawnień klucza

Klucze API są przypisane do obszaru roboczego, w którym zostały utworzone, i mają dostęp do:

  • Wszystkich agentów w obszarze roboczym
  • Punktów końcowych API czatu
  • Zarządzania webhookami

Klucze nie mogą:

  • Zarządzać członkami zespołu
  • Uzyskać dostępu do rozliczeń
  • Tworzyć innych kluczy API

Połączenie z Zapier

Podczas łączenia z Zapier:

  1. Utwórz dedykowany klucz API dla Zapier
  2. Użyj tego klucza w połączeniu z Zapier
  3. Nie używaj tego klucza do innych celów

Skonfiguruj Zapier →

Rozwiązywanie problemów

Błąd „Invalid API key”

  • Sprawdź, czy klucz został poprawnie skopiowany
  • Sprawdź, czy nie ma spacji na początku lub końcu
  • Upewnij się, że klucz nie został usunięty

Błąd „Key not authorized”

  • Upewnij się, że agent należy do Twojego obszaru roboczego
  • Sprawdź, czy obszar roboczy klucza się zgadza
  • Upewnij się, że Twój obszar roboczy korzysta z planu Hobby lub wyższego z aktywnymi rozliczeniami

Klucz nie działa po utworzeniu

  • Spróbuj odświeżyć stronę
  • Odczekaj 30 sekund na propagację
  • Jeśli problem nadal występuje, utwórz nowy klucz

Kolejne kroki