Endpoint lengkap, contoh request/response, dan panduan integrasi
API ini menyediakan layanan Retrieval-Augmented Generation (RAG) berbasis PHP + SQLite. Setiap percakapan memiliki memori sesi, retrieval dapat dilakukan secara lokal (cosine similarity di SQLite) atau via Pinecone.
| Base URL | https://api.syntaf.com/api |
|---|---|
| Format Request | JSON (Content-Type: application/json) |
| Format Response | JSON |
| Autentikasi Endpoint Chat | Tidak memerlukan API key eksternal; API key provider (Fireworks/Sambanova/Upstage/Gemini) dikelola di halaman admin. |
| Autentikasi Admin | PIN admin yang diatur saat setup pertama kali. |
apideploy/ ke root domain/subdomain Hostinger.pdo_sqlite, curl, json, mbstring.https://api.syntaf.com/index.php di browser untuk menjalankan setup wizard./api/chat.php akan mengembalikan HTTP 503 dengan pesan setup not complete.
/api/chat.phpMengirim pertanyaan ke chatbot RAG dan mendapatkan jawaban berdasarkan seluruh koleksi buku yang tersedia. Jika ingin membatasi ke satu buku, kirim book_id.
| Field | Tipe | Wajib | Keterangan |
|---|---|---|---|
book_id | integer | Tidak | ID buku untuk membatasi pencarian. Jika tidak dikirim, sistem mencari di semua buku. |
query | string | Ya | Pertanyaan atau pesan pengguna. |
provider | string | Tidak | LLM provider: fireworks, sambanova, upstage. Jika tidak dikirim, sistem memilih otomatis berdasarkan default admin atau provider pertama yang memiliki API key aktif. |
retrieval | string | Tidak | Metode retrieval: local (SQLite) atau pinecone. Jika tidak dikirim, menggunakan default yang diatur admin (saat ini: pinecone). |
session_id | string | Tidak | ID sesi untuk mempertahankan memori percakapan. Jika dikosongkan, sistem membuat sesi baru. |
top_k | integer | Tidak | Jumlah halaman top-K yang diambil. Default dari konfigurasi (biasanya 3). |
context_window | integer | Tidak | Jumlah halaman sebelum/sesudah halaman top-K yang disertakan. Default dari konfigurasi. |
Cukup kirim query; pencarian akan mencakup seluruh koleksi buku.
curl -X POST https://api.syntaf.com/api/chat.php \
-H "Content-Type: application/json" \
-d '{
"query": "apa itu gizi?",
"session_id": "sesi-001"
}'
Kirim book_id untuk membatasi pencarian ke satu buku.
curl -X POST https://api.syntaf.com/api/chat.php \
-H "Content-Type: application/json" \
-d '{
"book_id": 1,
"query": "apa itu gizi?",
"session_id": "sesi-001"
}'
Kirim provider dan/atau retrieval untuk menimpa pengaturan admin.
curl -X POST https://api.syntaf.com/api/chat.php \
-H "Content-Type: application/json" \
-d '{
"query": "apa itu gizi?",
"provider": "sambanova",
"retrieval": "pinecone",
"session_id": "sesi-001"
}'
{
"book_id": null,
"query": "apa itu gizi?",
"provider": "fireworks",
"retrieval": "pinecone",
"answer": "Gizi adalah proses tubuh menerima dan menggunakan zat makanan...",
"matched_pages": [
{"book_id": 1, "page_number": 76, "score": 0.7013},
{"book_id": 1, "page_number": 32, "score": 0.6795},
{"book_id": 2, "page_number": 5, "score": 0.6718}
],
"session_id": "sesi-001"
}
{
"error": "query is required"
}
{
"error": "setup not complete. run index.php first."
}
Admin dapat mengatur nilai default melalui halaman https://api.syntaf.com/admin.php:
| Pengaturan | Nilai Saat Ini | Deskripsi |
|---|---|---|
| Default Provider | upstage | Provider LLM yang digunakan ketika request tidak menyertakan provider. Jika kosong/tidak valid, sistem otomatis memilih provider pertama yang memiliki API key aktif. |
| Default Retrieval | pinecone | Metode retrieval yang digunakan ketika request tidak menyertakan retrieval. |
provider yang dikirim di request (jika valid).| Nilai | Deskripsi | Kapan Digunakan |
|---|---|---|
local | Menghitung cosine similarity langsung dari vektor embedding yang tersimpan di SQLite. | Cepat untuk buku kecil-menengah; tidak memerlukan Pinecone. |
pinecone | Mengambil vektor terdekat dari index Pinecone via REST API. | Untuk koleksi besar atau jika vektor sudah di-upload ke Pinecone. |
local. Untuk pinecone, pastikan vektor buku sudah di-upload ke index Pinecone yang dikonfigurasi.
API menyimpan riwayat percakapan per session_id dalam file JSON di server. Jika session_id tidak dikirim, sistem akan membuat ID baru dan mengembalikannya di response.
Untuk melanjutkan percakapan, kirim kembali session_id yang sama pada request berikutnya. LLM akan menerima riwayat pesan sebelumnya sebagai konteks.
{
"book_id": 1,
"query": "jelaskan lebih detail",
"session_id": "sesi-001"
}
API mendukung rotasi API key untuk beberapa provider. Provider aktif diatur di halaman admin.
| Provider | Parameter provider | Keterangan |
|---|---|---|
| Fireworks AI | fireworks | Default provider. |
| Sambanova AI | sambanova | Alternatif provider. |
| Upstage AI | upstage | Alternatif provider. |
Embedding selalu menggunakan Gemini Embedding API dengan output 1024 dimensi.
Fitur administratif tersedia di halaman terpisah yang dilindungi PIN:
https://api.syntaf.com/login.php — Login admin menggunakan PIN.https://api.syntaf.com/admin.php — Dashboard admin untuk mengelola API key, melihat status, dan konfigurasi.| Status | Arti |
|---|---|
| 200 | Request berhasil. |
| 400 | Bad request, parameter tidak valid atau tidak lengkap. |
| 405 | Method tidak diizinkan (hanya menerima POST). |
| 503 | Setup belum selesai atau service tidak tersedia. |
async function chat(bookId, query, sessionId = "") {
const res = await fetch("https://api.syntaf.com/api/chat.php", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
book_id: bookId,
query: query,
session_id: sessionId
// provider & retrieval opsional; akan dipilih otomatis oleh server
})
});
const data = await res.json();
console.log(data.answer);
console.log("provider:", data.provider);
console.log("retrieval:", data.retrieval);
console.log("session_id:", data.session_id);
return data;
}
.htaccess sudah dikonfigurasi untuk melindungi file sensitif dan menonaktifkan directory browsing.corpus.db) dan file sesi disimpan di server; pastikan permission folder cukup untuk write.setup not complete, buka index.php di browser untuk menyelesaikan setup.