Fejlesztői dokumentáció

Fejlesztői API egyéni integrációkhoz

Fejlesztőknek: Építsen egyéni chat felületeket, integrálja alkalmazásába, vagy csatlakozzon más eszközökhöz. Egyszerű REST API streaming támogatással. Nem fejlesztő? Használja kódmentes widgetünket — API nem szükséges. Így működik →

Alap URL

/api/v1

Állapot

Működik

Hitelesítés

Bearer kulcs + engedélyezett eredetek

Verzió

v1 · SSE streaming

Gyorsindítás

Három lépés egy éles üzenetküldő élmény indításához.

Hozzon létre egy hatókörrel rendelkező kulcsot, korlátozza az eredeteket, és hívja meg a chat végpontot streaming válaszokkal. Az alapértelmezések biztonságban tartják csapatát, miközben gyorsan halad.

Hatókörrel rendelkező kulcs létrehozása

Adjon ki API kulcsot alkalmazásonként engedélyezett eredetekkel a hozzáférés szabályozásához.

Engedélyezett eredetek beállítása

Engedélyezze az éles és tesztelési domaineket a kulcs kiszivárgásának megelőzéséhez.

Chat kérés küldése

Küldjön felhasználói üzenetet, opcionálisan streamelje a tokeneket, és naplózza a munkamenet azonosítót.

curl példa
curl -N https://obdal.com/api/v1/chat \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Summarize today’s incidents",
    "stream": true
  }'
# SSE stream delivers tokens as they’re generated
JS streaming
// Minimal fetch with streaming
const res = await fetch('/api/v1/chat', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${'$'}API_KEY`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ message: 'Hey!', stream: true })
});
// Read chunks as they arrive
for await (const chunk of res.body) {
  console.log(new TextDecoder().decode(chunk));
}
Végpontok

Fókuszált API felület, amely lefedi a teljes ügyfélfolyamatot.

Tartsa a válaszokat streamingelve és kövesse nyomon a munkameneteket extra infrastruktúra nélkül. Minden ésszerű alapértelmezésekkel érkezik.

POST

/api/v1/chat

JSON

Küldjön felhasználói üzenetet és kapjon streaming AI választ az adathalmaza alapján. A munkamenetek megőrzik a kontextust a fordulók között.

Kérés

{
  "message": "Summarize the outage playbook",
  "api_key": "your_api_key",
  "session_id": "sess_9Rna21",
  "stream": true
}

Válasz

event: message
data: {"content":"Hi there! I read through your playbook—here's the short version..."}

event: end
data: {"session_id":"sess_9Rna21"}
GET

/api/v1/usage

JSON

Kövesse nyomon a kéréseket, token használatot és költségeket alkalmazásonként, hogy csapata költségtudatos legyen.

Kérés

GET /api/v1/usage?api_key=your_api_key&start_date=2024-01-01

Válasz

{
  "success": true,
  "usage": {
    "total_requests": 1842,
    "total_input_tokens": 205401,
    "total_output_tokens": 216529,
    "total_tokens": 421930,
    "total_cost": 12.45
  },
  "by_model": []
}
GET

/api/v1/sessions

JSON

Kérje le a chat munkameneteket üzenetelőzményekkel és használati metaadatokkal az alkalmazásához.

Kérés

GET /api/v1/sessions?api_key=your_api_key&include_all=true

Válasz

{
  "success": true,
  "sessions": [
    {
      "session_id": "sess_9Rna21",
      "last_at": "2024-01-15T10:30:00Z",
      "total_tokens": 2430,
      "preview": "Hi there! I read through..."
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 20,
    "has_more": false
  }
}

Biztonság és megfelelőség

Vállalati szintű biztonság titkosítással nyugalmi állapotban és átvitel közben. Adatai védve maradnak.

Adatvédelem

Ön a tartalom tulajdonosa. Bármikor törölhet fájlokat a GDPR megfelelőségért. Pontosan szabályozza, hol jelenik meg a widgetje. Nincs zárolás, soha.

Biztonságos hozzáférés

TLS titkosítás, engedélyezett eredetek és hatókörrel rendelkező API kulcsok megakadályozzák az illetéktelen hozzáférést az adataihoz.

Megbízható infrastruktúra

SOC 2 auditált felhőinfrastruktúrán fut, átlátható adatmegőrzéssel. Fájljai és vektoradatai bármikor törölhetők.

Készen áll AI chatbotja építésére?

Töltse fel dokumentumait, ágyazza be a widgetet, és ügyfelei azonnal választ kapnak — a nap 24 órájában. Kezdje ingyen, és csak akkor váltson nagyobb csomagra, ha a forgalma megnő.