API Integrácia
Pushujte dáta programaticky do vašej AI SmartTalk znalostnej bázy pomocou našej REST API. Ideálne pre vlastné integrácie, automatizované pipeline a akýkoľvek zdroj dát, ktorý nie je pokrytý našimi natívnymi konektormi.
Prehľad
API integrácia vám umožňuje:
- Posielať dokumenty priamo do vašej znalostnej bázy
- Aktualizovať obsah programaticky
- Odstraňovať zastarané záznamy
- Vytvárať vlastné dátové pipeline
- Integrovať sa s akýmkoľvek systémom, ktorý dokáže vykonávať HTTP požiadavky
Požiadavky
Predtým, než začnete, zabezpečte, aby ste mali:
- Aktívny účet AI SmartTalk
- Povolený prístup k API (skontrolujte svoj plán)
- Základné znalosti o REST API
- Nástroj na vykonávanie HTTP požiadaviek (curl, Postman alebo váš aplikačný kód)
Získanie vašich API poverení
Krok 1: Prístup k nastaveniam API
- Prihláste sa do svojho účtu AI SmartTalk
- Prejdite na Nastavenia → Integrácie
- Nájdite API a kliknite na Konfigurovať
Krok 2: Vytvorenie API tokenu
- Kliknite na Vytvoriť nový token
- Skopírujte svoj ID modelu chatu a API token
- Uložte ich bezpečne—token sa zobrazuje iba raz!
⚠️ Upozornenie na bezpečnosť: Nikdy neodhaľujte svoj API token v kóde na strane klienta alebo vo verejných repozitároch.
API Endpoints
Základná URL
https://api.aismarttalk.tech/v1
Autentifikácia
Všetky požiadavky vyžadujú váš API token v hlavičke:
Authorization: Bearer YOUR_API_TOKEN
API Endpoints
Base URL
https://api.aismarttalk.tech/v1
Authentication
Všetky požiadavky vyžadujú váš API token v hlavičke:
Authorization: Bearer YOUR_API_TOKEN
Importovať Dokumenty
Endpoint
POST /documents/import
Telo požiadavky
{
"chatModelId": "your-chat-model-id",
"documents": [
{
"title": "Product Documentation",
"content": "Full content of your document goes here...",
"url": "https://example.com/docs/product",
"metadata": {
"category": "documentation",
"language": "en"
}
}
]
}
Parametre
| Pole | Typ | Povinné | Popis |
|---|---|---|---|
chatModelId | string | ✅ | Váš jedinečný identifikátor chat modelu |
documents | array | ✅ | Pole objektov dokumentov |
documents[].title | string | ✅ | Názov dokumentu na identifikáciu |
documents[].content | string | ✅ | Celý textový obsah |
documents[].url | string | ❌ | Zdrojová URL (na referenciu) |
documents[].metadata | object | ❌ | Vlastné páry kľúč-hodnota |
Odpoveď
{
"success": true,
"imported": 1,
"documents": [
{
"id": "doc_abc123",
"title": "Product Documentation",
"status": "processing"
}
]
}
Príklad: cURL
curl -X POST https://api.aismarttalk.tech/v1/documents/import \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"chatModelId": "your-chat-model-id",
"documents": [
{
"title": "Getting Started Guide",
"content": "Welcome to our platform. Here is how to get started...",
"url": "https://docs.example.com/getting-started"
}
]
}'
Dotaz na Dokumenty
Programovo sa pýtajte otázky voči vašej databáze znalostí.
Endpoint
POST /chat/query
Telo požiadavky
{
"chatModelId": "your-chat-model-id",
"query": "How do I reset my password?",
"options": {
"maxTokens": 500,
"temperature": 0.7
}
}
Odpoveď
{
"success": true,
"response": "To reset your password, navigate to Settings > Security > Change Password...",
"sources": [
{
"documentId": "doc_abc123",
"title": "Security Guide",
"relevance": 0.95
}
]
}
Získať Dokumenty
Získajte dokumenty, ktoré zodpovedajú dotazu (bez odpovede AI).
Endpoint
POST /documents/search
Telo požiadavky
{
"chatModelId": "your-chat-model-id",
"query": "password security",
"limit": 10
}
Odpoveď
{
"success": true,
"documents": [
{
"id": "doc_abc123",
"title": "Security Best Practices",
"content": "...",
"relevance": 0.92
}
]
}
Príklady Kódu
Python
import requests
API_TOKEN = "your-api-token"
CHAT_MODEL_ID = "your-chat-model-id"
def import_document(title: str, content: str, url: str = None):
response = requests.post(
"https://api.aismarttalk.tech/v1/documents/import",
headers={
"Authorization": f"Bearer {API_TOKEN}",
"Content-Type": "application/json"
},
json={
"chatModelId": CHAT_MODEL_ID,
"documents": [{
"title": title,
"content": content,
"url": url
}]
}
)
return response.json()
# Import a document
result = import_document(
title="FAQ: Doprava",
content="Ponúkame bezplatnú dopravu na objednávky nad 50 dolárov...",
url="https://shop.example.com/faq/shipping"
)
print(result)
JavaScript / Node.js
const API_TOKEN = 'your-api-token';
const CHAT_MODEL_ID = 'your-chat-model-id';
async function importDocument(title, content, url = null) {
const response = await fetch('https://api.aismarttalk.tech/v1/documents/import', {
method: 'POST',
headers: {
'Authorization': `Bearer ${API_TOKEN}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
chatModelId: CHAT_MODEL_ID,
documents: [{
title,
content,
url
}]
})
});
return response.json();
}
// Import a document
importDocument(
'FAQ: Vrátenia',
'Môžete vrátiť položky do 30 dní od nákupu...',
'https://shop.example.com/faq/returns'
).then(console.log);
PHP
<?php
$apiToken = 'your-api-token';
$chatModelId = 'your-chat-model-id';
$data = [
'chatModelId' => $chatModelId,
'documents' => [
[
'title' => 'Špecifikácie produktu',
'content' => 'Náš widget má nasledujúce špecifikácie...',
'url' => 'https://example.com/products/widget'
]
]
];
$ch = curl_init('https://api.aismarttalk.tech/v1/documents/import');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer ' . $apiToken,
'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
$response = curl_exec($ch);
curl_close($ch);
print_r(json_decode($response, true));
Prípady Použitia
Integrácia Vlastného CMS
Synchronizujte obsah z proprietárneho CMS:
- Pripojte sa k udalostiam publikovania v CMS
- Posuňte nový/aktualizovaný obsah do AI SmartTalk
- Odstráňte odstránený obsah
Dátový Pipeline
Importujte z dátových skladov:
- Exportujte relevantné dáta do JSON
- Hromadný import cez API
- Naplánujte pravidelné aktualizácie
E-commerce Produkty
Synchronizujte údaje o produktoch z vlastných systémov:
- Popisy produktov
- Špecifikácie
- Informácie o cenách
Interné Systémy
Prepojte interné nástroje, ktoré nie sú nativne podporované:
- Vlastné wiki
- Dedičské databázy
- Proprietárne aplikácie
Limity požiadaviek
| Endpoint | Limity požiadaviek |
|---|---|
| Import dokumentov | 100 požiadaviek/minúta |
| Dotaz | 60 požiadaviek/minúta |
| Vyhľadávanie | 60 požiadaviek/minúta |
Poznámka: Limity požiadaviek sa líšia podľa plánu. Kontaktujte podporu pre vyššie limity.
Správa chýb
Formát odpovede na chybu
{
"success": false,
"error": {
"code": "INVALID_TOKEN",
"message": "Poskytnutý API token je neplatný alebo vypršaný"
}
}
Bežné kódy chýb
| Kód | Popis | Riešenie |
|---|---|---|
INVALID_TOKEN | Zlý alebo vypršaný token | Regenerujte API token |
INVALID_MODEL_ID | Neznámy ID chat modelu | Skontrolujte svoj ID chat modelu |
RATE_LIMITED | Príliš veľa požiadaviek | Implementujte spätné oneskorenie, skúste neskôr |
INVALID_REQUEST | Chybne formátovaný obsah požiadavky | Skontrolujte štruktúru JSON |
DOCUMENT_TOO_LARGE | Obsah presahuje limit | Rozdeľte na menšie dokumenty |
QUOTA_EXCEEDED | Dosiahnuté limity plánu | Upgradujte alebo kontaktujte podporu |
Riešenie problémov
Zlyhanie autentifikácie
| Problém | Riešenie |
|---|---|
| 401 Neautorizované | Skontrolujte, či je token správny a aktívny |
| Token nefunguje | Regenerujte token v nastaveniach |
| Vypršaný token | Tokeny nevypršia, ale môžu byť odobraté |
Problémy s importom
| Problém | Riešenie |
|---|---|
| Prázdna odpoveď | Skontrolujte, či je Content-Type application/json |
| Dokument sa nezobrazuje | Počkajte na spracovanie; skontrolujte sekciu Znalosti |
| Čiastočný import | Niektoré dokumenty môžu mať validačné chyby |
Problémy s výkonom
| Problém | Riešenie |
|---|---|
| Pomalé importy | Skupinové dokumenty (max 100 na požiadavku) |
| Časové limity | Zmenšite veľkosť dávky, skúste znova so spätným oneskorením |
| Limity požiadaviek | Implementujte exponenciálne spätné oneskorenie |
Najlepšie postupy
- Skupinové importy: Posielajte viacero dokumentov na požiadavku (až 100)
- Jedinečné názvy: Používajte popisné, jedinečné názvy pre každý dokument
- Štruktúrovaný obsah: Dobre formátovaný obsah zlepšuje odpovede AI
- Označovanie metadátami: Používajte metadata na kategorizáciu a filtrovanie
- Bezpečné tokeny: Ukladajte tokeny do premenných prostredia
- Správa chýb: Implementujte logiku opakovania so exponenciálnym spätným oneskorením
- Monitorovanie používania: Sledujte API volania voči limitom vášho plánu
Súvisiaca dokumentácia
- Prehľad integrácií
- Úplná dokumentácia API
- Správa znalostnej bázy
- SmartFlow Webhooky — Prijímanie udalostí