API Reference
Awentail API vám umožňuje interagovat s vašimi AI asistenty programaticky. Chat endpoint je veřejný (nevyžaduje autentizaci) — je navržen pro vkládání widgetů.
Base URL
https://app.awentail.com/api
Chat Endpoint
POST /api/chat/:botId
Odešlete zprávu AI asistentovi a obdržte odpověď.
URL parametry:
| Parametr | Typ | Popis |
|---|---|---|
botId | string | Unikátní identifikátor asistenta (UUID) |
Tělo požadavku:
{
"message": "How do I reset my password?",
"conversationId": "optional-conversation-id"
}
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
message | string | Ano | Zpráva uživatele |
conversationId | string | Ne | Existující ID konverzace pro kontinuitu kontextu |
Odpověď:
{
"reply": "To reset your password, go to Settings > Security and click 'Change Password'. You'll need to enter your current password first.",
"conversationId": "conv_abc123"
}
| Pole | Typ | Popis |
|---|---|---|
reply | string | AI-generovaná odpověď asistenta |
conversationId | string | ID konverzace pro navazující zprávy |
Příklad:
curl -X POST https://app.awentail.com/api/chat/your-bot-id \
-H "Content-Type: application/json" \
-d '{"message": "What are your pricing plans?"}'
Rate Limiting
Chat endpoint je chráněn rate limitingem proti zneužití:
| Rozsah | Limit |
|---|---|
| Per IP + Asistent | 30 požadavků/minutu |
Při překročení limitu API vrátí odpověď 429 Too Many Requests.
Konfigurace widgetu
GET /api/chat/:botId/config
Získejte konfiguraci widgetu asistenta (název, uvítací zpráva, barvy).
Odpověď:
{
"name": "Support Assistant",
"welcomeMessage": "Hi! How can I help you today?",
"color": "#7C3AED"
}
Chybové odpovědi
Všechny chyby mají konzistentní formát:
{
"error": "Error description"
}
Běžné chybové kódy:
| Status | Význam |
|---|---|
400 | Chybný požadavek — chybějící nebo neplatná pole |
404 | Asistent nenalezen |
429 | Překročen rate limit |
500 | Interní chyba serveru |
Autentizace
Chat endpoint nevyžaduje autentizaci. Je navržen pro veřejné použití ve vložených widgetech.
Všechny správcovské endpointy (vytváření asistentů, nahrávání dokumentů, zobrazení analytiky) vyžadují JWT token získaný přihlášením. Tyto endpointy jsou používány interně dashboardem Awentail a nejsou dokumentovány jako veřejné API.
CORS
Chat API podporuje CORS z jakéhokoli originu, takže widget funguje na libovolném webu.
Webhooks
Awentail používá Stripe webhooks pro fakturační události. Pokud potřebujete webhook notifikace pro chatovací události, kontaktujte nás — pracujeme na tom.