Referensi

Agent API

Panduan memakai Agent API untuk memberi AI agent akses read-only ke workspace, leads, chat customer, analytics, dan conversion diagnostics.

01

Ringkasan Agent API

Agent API adalah akses read-only untuk AI agent, automation, atau connector yang perlu membaca data workspace Dalekta secara aman. API key dibuat dari menu API & Webhook dan selalu terikat ke workspace aktif saat key dibuat.

Ketersediaan paketAgent API hanya tersedia untuk Signal Pro dan Signal Max. Paket Signal Lite tetap bisa memakai tracking utama, tetapi tidak mendapat akses API key.
Base URL Agent APIBase URL yang benar untuk request Agent API adalah https://dalekta.id/api/agent. URL https://dalekta.id/docs/agent-api hanya halaman dokumentasi manusia, bukan endpoint API.
Workspace scopedRequest membaca workspace dari API key, bukan dari parameter bebas di URL.
Read-onlyEndpoint Agent API saat ini hanya membaca data. Tidak ada create/update/delete lead dari API agent.
Chat allowlistChat customer hanya bisa dibaca dari WhatsApp session yang dipilih saat membuat atau mengedit API key.
TraceableRequest authenticated menyertakan request ID dan rate-limit headers untuk membantu debugging.
02

URL yang dipakai

Untuk integrasi agent, cukup siapkan URL instruksi dan Agent API base URL. URL SKILL.md dipakai AI agent untuk membaca daftar endpoint dan aturan API secara machine-readable.

KebutuhanURLDipakai oleh
SKILL.md agenthttps://dalekta.id/api/agent/SKILL.mdAI agent, connector, automation
Base APIhttps://dalekta.id/api/agentRequest endpoint dengan Bearer API key
Rekomendasi untuk AI agentBerikan https://dalekta.id/api/agent/SKILL.md ke agent sebagai instruksi API, lalu simpan API key sebagai Bearer token di secret manager agent tersebut.
03

Membuat API key

  1. Buka dashboard Dalekta.
  2. Pilih workspace yang benar dari switcher workspace.
  3. Masuk ke menu API & Webhook.
  4. Klik tombol Tambah API key.
  5. Isi nama key, misalnya OpenClaw Agent, Claude Connector, atau Automasi Operasional.
  6. Pilih scope sesuai kebutuhan agent.
  7. Jika memilih agent.chats.read, pilih WhatsApp session yang boleh dibaca.
  8. Klik Buat key.
  9. Copy plaintext API key saat modal sukses muncul. Key hanya ditampilkan satu kali.
Copy sekaliPlaintext API key tidak bisa dilihat ulang setelah modal ditutup. Jika hilang, revoke key lama dan buat key baru.
04

Authentication

Semua endpoint Agent API selain SKILL.md membutuhkan Bearer token. Simpan API key di secret manager atau environment server-side, bukan di frontend publik.

bash
curl "https://dalekta.id/api/agent/workspace" \
  -H "Authorization: Bearer dlk_live_xxxxxxxxxxxxxxxxx" \
  -H "Accept: application/json"
Header responseResponse authenticated menyertakan X-Dalekta-Request-Id dan X-RateLimit-* untuk debugging dan observability.
05

Scopes

ScopeAkses
agent.workspace.readMembaca identitas workspace, timezone, currency, plan, dan konteks usage.
agent.leads.readMembaca daftar lead dan detail lead dalam workspace API key.
agent.chats.readMembaca chat customer untuk lead yang WhatsApp session-nya masuk allowlist key.
agent.analytics.readMembaca summary dashboard, funnel, dan campaign analytics.
agent.conversions.readMembaca status sync conversion dan pending/failed diagnostics.
Profil keyScope yang disarankan
Agent baca profil workspaceagent.workspace.read
Agent follow up leadsagent.workspace.read, agent.leads.read, agent.chats.read
Agent report performaagent.workspace.read, agent.analytics.read, agent.conversions.read
Agent read-only penuhSemua scope saat ini
06

Chat allowlist

Scope agent.chats.read saja belum cukup untuk membaca chat customer. API key juga harus punya WhatsApp session allowlist. Ini mencegah agent membaca chat dari nomor sales/CS lain yang tidak dipilih.

  • Allowlist dipilih saat membuat API key jika agent.chats.read aktif.
  • Allowlist bisa diedit dari tabel API key dengan tombol Akses.
  • Jika lead memakai WhatsApp session di luar allowlist, endpoint messages mengembalikan 403.
  • Jika key tidak punya scope chat, endpoint messages juga mengembalikan 403.
07

Endpoint ringkas

MethodEndpointScope
GET/api/agent/workspaceagent.workspace.read
GET/api/agent/leadsagent.leads.read
GET/api/agent/leads/:idagent.leads.read
GET/api/agent/leads/:id/messagesagent.chats.read + allowlist session
GET/api/agent/analytics/summaryagent.analytics.read
GET/api/agent/analytics/funnelagent.analytics.read
GET/api/agent/analytics/campaignsagent.analytics.read
GET/api/agent/conversions/statusagent.conversions.read
GET/api/agent/conversions/pendingagent.conversions.read
08

Contoh prompt untuk agent

Contoh ini menunjukkan cara agent menerjemahkan pertanyaan user menjadi request API. Untuk kata seperti hari ini, minggu ini, atau bulan ini, agent sebaiknya membaca timezone workspace dulu dari /api/agent/workspace, lalu mengubahnya menjadi range from/to atau createdFrom/createdTo.

User bertanyaEndpoint yang dipakai agentJawaban yang diharapkan
tolong cek berapa leads hari iniGET /api/agent/analytics/summary?from=2026-07-27T00:00:00+07:00&to=2026-07-27T23:59:59+07:00Agent menjawab angka Masuk WA, MQL, Prospek, Closing, revenue, dan conversion rate hari ini.
tampilkan 10 leads terbaru hari iniGET /api/agent/leads?createdFrom=2026-07-27T00:00:00+07:00&createdTo=2026-07-27T23:59:59+07:00&limit=10&sortBy=createdAt&sortOrder=descAgent menampilkan daftar ringkas lead terbaru: nama/kode, status, source, campaign, sales, dan waktu masuk.
cek leads closing minggu iniGET /api/agent/leads?status=CLOSING&from=2026-07-21T00:00:00+07:00&to=2026-07-27T23:59:59+07:00&limit=50Agent merangkum lead closing, nominal closing jika ada, campaign/source, dan total revenue.
lead dari campaign Promo Juli ada berapa?GET /api/agent/leads?campaign=Promo%20Juli&limit=100Agent menghitung total dari pagination dan menampilkan contoh lead yang paling baru.
baca chat lead K-8F21AGET /api/agent/leads?search=K-8F21A&limit=1, lalu GET /api/agent/leads/:id/messagesAgent mencari lead dulu, lalu membaca messages jika API key punya agent.chats.read dan session masuk allowlist.
conversion yang gagal apa saja?GET /api/agent/conversions/pending?status=FAILED&limit=20Agent menampilkan event conversion gagal, error utama, jumlah attempt, dan lead/campaign terkait.
Format jawaban agentAgent sebaiknya mengubah response API menjadi ringkasan operasional: angka utama, perubahan yang perlu dicek, dan data pendukung yang relevan.
text
User: tolong cek berapa leads hari ini
Agent steps:
1. GET /api/agent/workspace untuk membaca timezone workspace.
2. Hitung range hari ini sesuai timezone workspace.
3. GET /api/agent/analytics/summary?from=<awal_hari>&to=<akhir_hari>.
4. Jawab ringkas: total Masuk WA, MQL, Prospek, Closing, revenue, dan catatan jika ada angka yang perlu dicek.

Contoh jawaban:
Hari ini ada 18 lead Masuk WA, 7 MQL, 3 Prospek, dan 2 Closing. Revenue tercatat Rp2.500.000. Dari sisi funnel, rasio Closing ke Masuk WA sekitar 11,11%.
09

Contoh request

bash
curl "https://dalekta.id/api/agent/leads?limit=20&status=CLOSING" \
  -H "Authorization: Bearer dlk_live_xxxxxxxxxxxxxxxxx" \
  -H "Accept: application/json"
bash
curl "https://dalekta.id/api/agent/leads/LEAD_ID/messages" \
  -H "Authorization: Bearer dlk_live_xxxxxxxxxxxxxxxxx" \
  -H "Accept: application/json"
bash
curl "https://dalekta.id/api/agent/analytics/campaigns?from=2026-07-01&to=2026-07-31" \
  -H "Authorization: Bearer dlk_live_xxxxxxxxxxxxxxxxx" \
  -H "Accept: application/json"
10

Error dan rate limit

Error Agent API memakai format JSON konsisten supaya agent bisa mengambil keputusan tanpa parsing teks bebas.

json
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Missing required scope: agent.chats.read",
    "requestId": "req_..."
  }
}
StatusMakna umum
401API key hilang, format Bearer salah, key tidak ditemukan, atau key sudah revoked.
403Scope tidak cukup, chat session tidak masuk allowlist, atau IP tidak diizinkan jika allowlist aktif.
404Resource tidak ditemukan di workspace API key.
429Rate limit terlampaui. Kurangi frekuensi request atau gunakan pagination/filter.
500Gangguan server. Simpan request ID untuk kebutuhan bantuan teknis.
11

Rekomendasi keamanan

  • Buat satu API key per agent atau integration agar revoke dan audit lebih jelas.
  • Pakai scope terkecil yang masih cukup untuk pekerjaan agent.
  • Untuk agent yang membaca chat, pilih hanya WhatsApp session yang relevan.
  • Simpan API key di secret manager atau environment server-side, bukan di frontend publik, screenshot, atau chat grup.
  • Gunakan pagination dan filter tanggal supaya agent tidak menarik data terlalu besar.
  • Revoke key yang tidak dipakai lagi dari menu API & Webhook.
Dalekta | Agent API | Dokumentasi Dalekta