API Reference

API Reference

Referensi lengkap semua REST API ConAI. 43+ endpoint yang mencakup Neural Core, Provisioning, Autoscale, Skill Pack SDK, Billing, dan operasional sistem.

43+

Total Endpoint

6

API Groups

2

Auth Methods

v1

Base Version

Authentication

Semua API endpoint memerlukan autentikasi. ConAI mendukung dua metode autentikasi.

Bearer Token (JWT)

Untuk akses user-scoped. Token didapat dari login endpoint.

Authorization: Bearer eyJhbGciOi...

API Key

Untuk akses service-to-service. Key di-generate dari Dashboard.

X-API-Key: cai_live_abc123...

Rate Limiting

Semua endpoint dilindungi rate limit. Default: 100 request/menit untuk JWT, 1000 request/menit untuk API Key. Response header X-RateLimit-Remaining menunjukkan sisa quota. Saat limit tercapai, response 429 dengan header Retry-After.

Neural Core V2

Inference engine untuk AI Agent — intent classification, response generation, dan multi-agent orchestration.

Base: /api/v1/neuralAuth: Bearer Token (JWT)
MethodEndpointDeskripsi
POST/api/v1/neural/inferJalankan inference — kirim prompt, terima response dari AI Agent
POST/api/v1/neural/orchestrateMulti-agent orchestration — kirim task ke beberapa agent sekaligus
GET/api/v1/neural/agentsList semua AI Agent yang aktif
GET/api/v1/neural/agents/:idDetail konfigurasi agent tertentu
PUT/api/v1/neural/agents/:idUpdate konfigurasi agent
GET/api/v1/neural/sessionsList sesi percakapan aktif
GET/api/v1/neural/sessions/:id/historyRiwayat percakapan agent dengan user
POST/api/v1/neural/contextInject context/knowledge ke agent

Provisioning API

Integrasi MikroTik RouterOS, OLT, dan sistem penagihan untuk ISP.

Base: /api/v1/provisioningAuth: Bearer Token (JWT)
MethodEndpointDeskripsi
GET/api/v1/provisioning/devicesList semua perangkat jaringan (MikroTik, OLT)
POST/api/v1/provisioning/devicesDaftarkan perangkat baru
POST/api/v1/provisioning/pppoe/createBuat PPPoE secret baru untuk pelanggan
DELETE/api/v1/provisioning/pppoe/:usernameHapus PPPoE secret
POST/api/v1/provisioning/bandwidth/setSet bandwidth limit untuk pelanggan
GET/api/v1/provisioning/pppoe/activeList PPPoE sessions aktif
POST/api/v1/provisioning/olt/onuProvisioning ONU di OLT
GET/api/v1/provisioning/olt/onu/:sn/statusStatus ONU berdasarkan serial number

Sovereign Autoscale

Pengelolaan resource VPS secara dinamis berdasarkan demand dan kebijakan.

Base: /api/v1/autoscaleAuth: Bearer Token (JWT) + Service Key
MethodEndpointDeskripsi
GET/api/v1/autoscale/policiesList kebijakan autoscale yang aktif
POST/api/v1/autoscale/policiesBuat kebijakan autoscale baru
PUT/api/v1/autoscale/policies/:idUpdate kebijakan autoscale
DELETE/api/v1/autoscale/policies/:idHapus kebijakan autoscale
GET/api/v1/autoscale/vpsList VPS dengan status resource saat ini
POST/api/v1/autoscale/vps/:id/resizeTrigger resize VPS manual
GET/api/v1/autoscale/eventsRiwayat autoscale events

Skill Pack SDK

Manage Skill Packs — upload, install, test, dan distribusi custom skill.

Base: /api/v1/sdkAuth: API Key
MethodEndpointDeskripsi
POST/api/v1/sdk/packsUpload & publikasi Skill Pack baru
GET/api/v1/sdk/packsList Skill Pack yang tersedia
GET/api/v1/sdk/packs/:idDetail Skill Pack
PUT/api/v1/sdk/packs/:idUpdate metadata Skill Pack
DELETE/api/v1/sdk/packs/:idHapus Skill Pack
POST/api/v1/sdk/packs/:id/installInstall Skill Pack ke Agent
POST/api/v1/sdk/packs/:id/testJalankan test suite di sandbox

Billing & Payments

Langganan, invoice, pembayaran, dan manajemen paket.

Base: /api/v1/billingAuth: Bearer Token (JWT)
MethodEndpointDeskripsi
GET/api/v1/billing/subscriptionStatus langganan saat ini
POST/api/v1/billing/subscription/upgradeUpgrade paket langganan
POST/api/v1/billing/subscription/cancelBatalkan langganan
GET/api/v1/billing/invoicesList semua invoice
GET/api/v1/billing/invoices/:idDetail invoice
POST/api/v1/billing/payment/createBuat pembayaran baru (generates payment link)
GET/api/v1/billing/payment/:id/statusStatus pembayaran

Operations

Runbook execution, monitoring, dan webhook management.

Base: /api/v1/opsAuth: Bearer Token (JWT)
MethodEndpointDeskripsi
GET/api/v1/runbooksList semua runbook
POST/api/v1/runbooks/:id/executeJalankan runbook
GET/api/v1/ops/alertsList alert aktif
POST/api/v1/ops/webhooksDaftarkan webhook baru
GET/api/v1/ops/audit-logAudit log aktivitas
GET/api/v1/ops/healthHealth check endpoint

Global Error Codes

Error codes yang berlaku untuk semua API group. Format response error:

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed",
    "details": {
      "email": ["Invalid email format"],
      "name": ["Required field"]
    },
    "requestId": "req_abc123"
  }
}
CodeHTTP StatusDeskripsi
UNAUTHORIZED401Token/API key tidak valid atau sudah expired
FORBIDDEN403Tidak memiliki izin untuk mengakses resource
NOT_FOUND404Resource yang diminta tidak ditemukan
VALIDATION_ERROR400Request body atau parameter tidak valid
RATE_LIMITED429Batas rate limit tercapai — coba lagi setelah retry-after
INTERNAL_ERROR500Server error — hubungi support jika persisten
SERVICE_UNAVAILABLE503Layanan sedang maintenance atau overloaded
CONFLICT409Konflik state — operasi tidak bisa dilakukan saat ini

SDKs & Client Libraries

Gunakan official SDK untuk integrasi yang lebih mudah.

Node.js / TypeScript

npm install @conai/sdk

Python

pip install conai-sdk

Go

go get conai.id/sdk/go

API Versioning

Semua endpoint menggunakan versi URL (/api/v1/). Perubahan breaking akan diumumkan minimal 90 hari sebelumnya melalui Changelog dan email. Endpoint deprecated akan tetap berfungsi selama 6 bulan setelah pengumuman.

← Documentation HubNeural Core V2 →Provisioning API →Sovereign Autoscale →