API Reference
Dashboard REST API Referensi endpoint REST untuk mengelola key, providers, chains, guardrails, dan usage.
Semua endpoint di bawah hidup di server yang sama dengan gateway (default http://localhost:8080) dan dipakai oleh dashboard UI. Cocok untuk otomasi dan integrasi.
Referensi endpoint inference ada di bagian Gateway API .
# masuk curl -X POST http://localhost:8080/v1/auth/sign-in \ -H "Content-Type: application/json" \ -d '{ "email": "[email protected] ", "password": "..." }' { "data" : { "uid" : "…" , "email" : "[email protected] " , "access_token" : "…" , "refresh_token" : "…" , "expires_in" : 3600 } }
Access token berlaku 1 jam; refresh token 30 hari dan dirotasi tiap pembaruan.
Bawa token di header Authorization: Bearer <access_token>.
POST /v1/auth/sign-out mencabut semua token sesi.
Bentuk Bentuk JSON Satu resource {"data": …, "metadata": …, "message": …}Daftar {"data": […], "metadata": {"total", "offset", "limit"}}Hapus {"message": "…"}Error {"message": "…"}Error validasi {"message": "…", "errors": {…}} (422)
Pagination memakai query offset (0-based) dan limit (default 10, maks 100).
Method Path Keterangan POST /v1/auth/sign-inMasuk, terima token POST /v1/auth/refreshRotasi refresh token GET /v1/auth/meProfil user saat ini POST /v1/auth/sign-outCabut semua token sesi
Method Path Keterangan GET / POST /v1/keysDaftar / buat key GET / PUT / PATCH /v1/keys/:idDetail / ubah key POST /v1/keys/:id/revealKembalikan plaintext key (teraudit) DELETE /v1/keys/:idHapus key
Method Path Keterangan GET / POST /v1/plansDaftar / buat GET /v1/plans/:idDetail GET /v1/plans/:id/keysKey di plan ini PUT / PATCH /v1/plans/:idUbah DELETE /v1/plans/:idHapus
Method Path Keterangan GET / POST /v1/chainsDaftar / buat chain GET /v1/chains/:idDetail chain GET /v1/chains/:id/usagePemakaian chain PUT / PATCH /v1/chains/:idUbah chain DELETE /v1/chains/:idHapus chain GET / PUT / DELETE /v1/models/aliasKelola alias pool
Method Path Keterangan GET /v1/providersRingkasan provider terhubung/tersedia GET /v1/providers/ratesSnapshot harga GET / POST /v1/custom-providersCustom provider PUT / PATCH / DELETE /v1/custom-providers/:idKelola custom provider POST /v1/validate-keyUji kredensial sebelum disimpan GET / POST /v1/accountsDaftar / tambah akun POST /v1/accounts/bulkTambah banyak akun sekaligus GET / PUT / PATCH / DELETE /v1/accounts/:idKelola akun POST /v1/accounts/:id/testUji koneksi akun POST /v1/accounts/:id/revealKembalikan kredensial (teraudit) GET /v1/accounts/:id/quotaKuota akun POST /v1/accounts/:id/quota/resetReset kuota akun POST /v1/providers/:id/accounts/disable-all / enable-allMassa per provider DELETE /v1/providers/:id/accounts/disabled / allHapus massa
Method Path Keterangan GET / POST /v1/budgetsDaftar / buat budget GET /v1/budgets/statusPemakaian berjalan per budget PUT / PATCH / DELETE /v1/budgets/:idKelola budget GET /v1/usage?range=today|24h|7d|30dRingkasan request/token/biaya/latensi GET /v1/usage/modelsPemakaian per model GET /v1/usage/insightsRingkasan + tren harian + per model GET /v1/usage/telemetryPayload penuh halaman Usage GET /v1/quotaDaftar kuota aktif GET /v1/quota/overviewRingkasan kuota PATCH / DELETE /v1/quota/:idJeda / hapus kuota
Method Path Keterangan GET / POST /v1/proxy-poolsDaftar / buat pool POST /v1/proxy-pools/health-checkCek kesehatan semua PUT / PATCH / DELETE /v1/proxy-pools/:idKelola pool POST /v1/proxy-pools/:id/testUji satu pool
Method Path Keterangan GET / POST / DELETE /v1/model-pricing-overridesTimpa harga per model GET / PUT /v1/capability-overridesTimpa kapabilitas model DELETE /v1/capability-overrides/:provider/:modelHapus satu override POST /v1/capability-overrides/resetReset semua
Method Path Keterangan GET /v1/guardrailsRingkasan kebijakan POST /v1/guardrailsBuat kebijakan PUT /v1/guardrails/settingsSettings guardrail global POST /v1/guardrails/evaluateUji kebijakan (dry run) PUT / PATCH / DELETE /v1/guardrails/:idKelola kebijakan
Method Path Catatan GET /v1/tunnels/cloudflareinstalled, running, dan url quick tunnelPOST /v1/tunnels/cloudflare/enableNyalakan quick tunnel (diingat setelah restart) POST /v1/tunnels/cloudflare/disableMatikan dan biarkan mati GET /v1/tunnels/tailscaleinstalled, logged_in, running, dan url tailnetPOST /v1/tunnels/tailscale/enabletailscale serve --bg server ini lewat HTTPSPOST /v1/tunnels/tailscale/disableHapus pemetaan serve milik server ini
Menyalakan dan mematikan tercatat di audit log. Lihat Akses jarak jauh .
Method Path Keterangan GET / PUT / PATCH /v1/settingsSettings router (timeout, round-robin, dst.) GET / POST /v1/skillsDaftar / buat skill PATCH /v1/skills/:idNyalakan/matikan injeksi gateway (enabled) DELETE /v1/skills/:idHapus skill GET / DELETE /v1/consoleLog ring buffer (500 entri) / bersihkan GET /v1/system/statsMetrik host & proses GET /v1/mediaProvider katalog per kemampuan non-chat GET /healthKesehatan server (tanpa auth)