API Reference

Awentail API vám umožňuje pracovat s AI asistenty programově. Chat endpoint je veřejný (nevyžaduje autentizaci) - je navržen pro vkládání widgetů.

Základní URL

https://app.awentail.com/api

Endpoint pro chat

POST /api/chat/:botId

Odešlete zprávu AI asistentovi a získáte odpověď.

URL parametry:

ParametrTypPopis
botIdstringUnikátní identifikátor asistenta (UUID)

Tělo požadavku:

{
  "message": "How do I reset my password?",
  "conversationId": "optional-conversation-id"
}
PoleTypPovinnéPopis
messagestringAnoZpráva uživatele
conversationIdstringNeExistují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"
}
PoleTypPopis
replystringodpověď vygenerovaná AI
conversationIdstringID 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?"}'

Omezení počtu požadavků

Chat endpoint je chráněn omezením počtu požadavků proti zneužití:

RozsahLimit
Na IP adresu a asistenta30 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": "#3B6FE8"
}

Chybové odpovědi

Všechny chyby mají konzistentní formát:

{
  "error": "Error description"
}

Běžné chybové kódy:

StatusVýznam
400Chybný požadavek - chybějící nebo neplatná pole
404Asistent nenalezen
429Překročen limit požadavků
500Interní 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ě přehledem 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á webhooky platební brány pro fakturační události. Pokud potřebujete webhook notifikace pro chatovací události, kontaktujte nás - pracujeme na tom.