Dokumentacja

Uwierzytelnianie

Uwierzytelniaj żądania API za pomocą tokenów Bearer, wykorzystując swój klucz API.

Wszystkie żądania API wymagają uwierzytelnienia za pomocą tokenu Bearer. Wygeneruj klucz API w panelu i dołącz go do nagłówka Authorization.

Uwaga: dostęp do API wymaga planu Hobby lub wyższego, z aktywnymi rozliczeniami.

Generowanie klucza API

  1. Przejdź do panelu obszaru roboczego swojego zespołu
  2. Kliknij Klucze API na pasku bocznym
  3. Kliknij Utwórz klucz API
  4. Skopiuj wygenerowany klucz

Używanie klucza API

Dołącz klucz do nagłówka Authorization:

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"}]}'

Format nagłówka

Authorization: Bearer YOUR_API_KEY

Testowanie klucza

Sprawdź, czy Twój klucz API działa, za pomocą punktu końcowego uwierzytelniania:

curl 'https://your-domain.com/api/v1/auth' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Odpowiedź w przypadku powodzenia (200):

{
  "id": "account-uuid",
  "name": "Your Workspace",
  "email": "[email protected]"
}

Nieprawidłowy klucz (401):

{
  "message": "Missing or invalid Authorization header"
}

Bezpieczeństwo kluczy API

Najlepsze praktyki

  1. Nigdy nie ujawniaj kluczy w kodzie po stronie klienta — klucze API powinny być używane wyłącznie po stronie serwera
  2. Używaj zmiennych środowiskowych — nie umieszczaj kluczy na stałe (hardcode) w kodzie
  3. Rotuj klucze okresowo — usuwaj stare klucze i twórz nowe
  4. Nadawaj kluczom opisowe nazwy — dzięki temu wiesz, który klucz jest używany gdzie

Format klucza

Klucze to 32 losowe bajty zakodowane w formacie base64url.

Zarządzanie kluczami API

Wyświetlanie wszystkich kluczy

Wszystkie klucze znajdziesz w sekcji Obszar roboczy > Klucze API.

Usuwanie kluczy

Usuwaj klucze, których już nie potrzebujesz:

  1. Przejdź do Klucze API
  2. Znajdź klucz
  3. Kliknij Usuń
  4. Potwierdź usunięcie

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

Odpowiedzi błędów

StatusWiadomośćPrzyczyna
401Missing or invalid Authorization headerNagłówek nie został podany
401Invalid API keyKlucz jest nieprawidłowy
403API access requires a Hobby plan or above with active billingPlan lub stan rozliczeń nie pozwala na dostęp do API
403Chatbot does not belong to this accountIdentyfikator agenta nie należy do konta powiązanego z kluczem API

Konfiguracja środowiska

Node.js

const API_KEY = process.env.AGENTKIT_API_KEY;

const response = await fetch('https://your-domain.com/api/v1/chat', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    chatbotId: 'your-chatbot-id',
    messages: [{ role: 'user', content: 'Hello' }],
  }),
});

Python

import os
import requests

API_KEY = os.environ.get('AGENTKIT_API_KEY')

response = requests.post(
    'https://your-domain.com/api/v1/chat',
    headers={
        'Authorization': f'Bearer {API_KEY}',
        'Content-Type': 'application/json',
    },
    json={
        'chatbotId': 'your-chatbot-id',
        'messages': [{'role': 'user', 'content': 'Hello'}],
    },
)

cURL

export AGENTKIT_API_KEY="your-api-key"

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

Kolejne kroki