API Integratioun

Push Daten programmatesch an Ärer AI SmartTalk Wëssenbasis mat eiser REST API. Ideal fir personaliséiert Integratiounen, automatiséiert Pipelines, an all Datenquell déi net vun eisen nativen Connectoren ënnerstëtzt gëtt.

---

Iwwerbléck

D'API Integratioun erlaabt Iech:

• Dokumenter direkt an Är Wëssenbasis ze pushen
• Inhalter programmatesch ze aktualiséieren
• Veraltet Entréeën ze läschen
• Personalizéiert Datenpipelines ze bauen
• Integréieren mat all System dat HTTP Ufroen kann maachen

---

Virbedingunge

Elo Dir ufänkt, stellt sécher datt Dir:

• Eng aktiv AI SmartTalk Kont huet
• API Zougang aktivéiert (kontrolléiert Ären Plang)
• Basiswëssen iwwer REST APIs
• Eng Tool fir HTTP Ufroen ze maachen (curl, Postman, oder Äre Applikatiounscode)

---

Ären API Credentials kréien

Schrëtt 1: Zougang zu API Astellungen

1. Loggt Iech an Ärem AI SmartTalk Kont an
2. Navigéiert op Astellungen → Integratiounen
3. Fannt API a klickt op Konfiguréieren

Schrëtt 2: Generéiert API Token

1. Klickt op Generéiert Neit Token
2. Koppéiert Ären Chat Model ID an API Token
3. Späichert dës sécher – d'Token gëtt nëmmen eemol gewisen!

⚠️ Sécherheetswarnung: Exposeéiert ni Ären API Token an Client-Säit Code oder ëffentleche Repositories.

---

API Endpoints

Basis URL

https://api.aismarttalk.tech/v1

Authentifikatioun

All Ufroen erfuerderen Ären API Token am Header:

Authorization: Bearer YOUR_API_TOKEN

---

Dokumenter importéieren

Endpoint

POST /documents/import

Ufro Kapp

{
  "chatModelId": "your-chat-model-id",
  "documents": [
    {
      "title": "Produkt Dokumentatioun",
      "content": "Voll Inhalt vun Ärem Dokument geet hei...",
      "url": "https://example.com/docs/product",
      "metadata": {
        "category": "documentation",
        "language": "en"
      }
    }
  ]
}

Parameteren

Feld	Typ	Erfuerderlech	Beschreiwung
chatModelId	string	✅	Ären eenzegaartegen Chat Modell Identifikator
documents	array	✅	Array vun Dokumentobjekten
documents[].title	string	✅	Dokumenttitel fir Identifikatioun
documents[].content	string	✅	Voll Textinhalt
documents[].url	string	❌	Quell URL (fir Referenz)
documents[].metadata	object	❌	Personaliséiert Schlüssel-Wäert Paar

Äntwert

{
  "success": true,
  "imported": 1,
  "documents": [
    {
      "id": "doc_abc123",
      "title": "Produkt Dokumentatioun",
      "status": "processing"
    }
  ]
}

Beispill: 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": "Guide fir unzefänken",
        "content": "Wëllkomm op eiser Plattform. Hei ass wéi Dir ufänke kënnt...",
        "url": "https://docs.example.com/getting-started"
      }
    ]
  }'

---

Dokumenter froen

Frot Froen géint Är Wëssenbasis programmatesch.

Endpoint

POST /chat/query

Ufro Kapp

{
  "chatModelId": "your-chat-model-id",
  "query": "Wéi kann ech meng Passwuert zrécksetzen?",
  "options": {
    "maxTokens": 500,
    "temperature": 0.7
  }
}

Äntwert

{
  "success": true,
  "response": "Fir Äert Passwuert zréckzesetzen, navigéiert op Astellungen > Sécherheet > Passwuert änneren...",
  "sources": [
    {
      "documentId": "doc_abc123",
      "title": "Sécherheetsguide",
      "relevance": 0.95
    }
  ]
}

---

Dokumenter recuperéieren

Kritt Dokumenter déi mat enger Ufro übereenstëmmen ( ouni AI Äntwert).

Endpoint

POST /documents/search

Ufro Kapp

{
  "chatModelId": "your-chat-model-id",
  "query": "passwuert séchergestallt",
  "limit": 10
}

Äntwert

{
  "success": true,
  "documents": [
    {
      "id": "doc_abc123",
      "title": "Sécherheetsbest Practices",
      "content": "...",
      "relevance": 0.92
    }
  ]
}

---

Code Beispiller

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éiert e Dokument
result = import_document(
    title="FAQ: Versand",
    content="Mir bidden gratis Versand fir Bestellungen iwwer $50...",
    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éiert e Dokument
importDocument(
  'FAQ: Retouren',
  'Dir kënnt Artikelen innerhalb vun 30 Deeg no der Kaf zréckginn...',
  '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' => 'Produkt Spezifikatiounen',
            'content' => 'Eis Widget huet déi folgend Spezifikatiounen...',
            '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));

---

Benotzungsfäll

Personalizéiert CMS Integratioun

Synchroniséiert Inhalt vun engem proprietären CMS:

• Hook an CMS Publikatiounsereignisser
• Push nei/aktualiséiert Inhalt an AI SmartTalk
• Läscht geläscht Inhalt

Datenpipeline

Importéiert aus Datenlager:

• Exportéiert relevant Daten an JSON
• Batch Import iwwer API
• Plangt regelméisseg Updates

E-commerce Produkter

Synchroniséiert Produktdaten aus personaliséierten Systemer:

• Produktbeschreiwungen
• Spezifikatiounen
• Präisinformatioun

Intern Systemer

Verbindt intern Tools déi net natierlech ënnerstëtzt sinn:

• Personalizéiert Wikis
• Legacy Datenbanken
• Proprietär Applikatiounen

---

Rate Limiten

Endpoint	Rate Limit
Dokument Import	100 Ufroën/minutt
Fro	60 Ufroën/minutt
Sich	60 Ufroën/minutt

Bemierkung: Rate Limiten variéieren no Plang. Kontaktéiert de Support fir héichere Limiten.

---

Feelerbehandlung

Feeleräisformaat

{
  "success": false,
  "error": {
    "code": "INVALID_TOKEN",
    "message": "De geliwwerten API Token ass ongëlteg oder ofgelaf"
  }
}

Gewéinlech Fehlercodes

Code	Beschreiwung	Léisung
INVALID_TOKEN	Ongëlteg oder ofgelaf Token	Regeneréiert API Token
INVALID_MODEL_ID	Onbekannt Chat Modell ID	Kontrolléiert Ären Chat Modell ID
RATE_LIMITED	Ze vill Ufroen	Implementéiert Backoff, probéiert méi spéit nach eng Kéier
INVALID_REQUEST	Malforméiert Ufro Kéier	Kontrolléiert JSON Struktur
DOCUMENT_TOO_LARGE	Inhalt iwwersteigt Limit	Spléckt an méi kleng Dokumenter
QUOTA_EXCEEDED	Plang Limiten erreecht	Upgrade oder kontaktéiert de Support

---

Problemerléisung

Authentifikatioun feiert

Probleem	Léisung
401 Unauthorized	Kontrolléiert ob de Token korrekt an aktiv ass
Token funktionéiert net	Regeneréiert Token an den Astellungen
Ofgelaf Token	Tokens lafen net of, kënnen awer zréckgezunn ginn

Importproblemer

Probleem	Léisung
Leere Äntwert	Kontrolléiert ob de Content-Type application/json ass
Dokument net sichtbar	Waart op Veraarbechtung; kontrolléiert de Wëssen Abschnitt
Partiellen Import	E puer Dokumenter kënnen Validatiounsfeeler hunn

Leeschtung Problemer

Probleem	Léisung
Langsame Importer	Batch Dokumenter (max 100 pro Ufro)
Timeout	Reduzéiert Batch Gréisst, probéiert mat Backoff
Rate limitéiert	Implementéiert exponentiellen Backoff

---

Bescht Praktiken

1. Batch Importer: Schéckt méi Dokumenter pro Ufro (bis zu 100)
2. Eenzegaarteg Titelen: Benotzt beschreiwende, eenzegaarteg Titelen fir all Dokument
3. Strukturéiert Inhalt: Gutt formatéiert Inhalt verbessert AI Äntwerten
4. Metadata Tagging: Benotzt Metadata fir Kategoriséierung an Filterung
5. Sécher Token: Späichert Tokens an Ëmfeldvariabelen
6. Feeler behandelen: Implementéiert Retry Logik mat exponentiellem Backoff
7. Benotzung iwwerwaachen: Verfollegt API Uruff géint Är Plang Limiten

---

Verbonnen Dokumentatioun

• Integratiounen Iwwerbléck
• Voll API Dokumentatioun
• Wëssen Basis Management
• SmartFlow Webhooks — Empfänkt Evenementer