Lewati ke konten

Referensi API

Referensi untuk operasi WorkItem, kontrol langkah keputusan, eksekusi integrasi, dan ekspor telemetri.

API ini dirancang untuk perilaku otomatisasi yang dapat diprediksi dengan kebijakan eksplisit dan cakupan tenant.

Endpoint dasar

Gunakan endpoint API publik yang telah Anda konfigurasi untuk permintaan terautentikasi.

https://api.threada.ai

Autentikasi dan konteks

  • Gunakan kredensial tercakup untuk akses API
  • Sertakan konteks tenant dan peran jika diperlukan
  • Permintaan tanpa konteks valid gagal tertutup

Cakupan umum

  • workitems:read dan workitems:write
  • workflow:manage untuk pembaruan kebijakan dan keputusan
  • actions:execute untuk eksekusi yang diatur
  • telemetry:read untuk ekspor dan analisis

Paginasi dan filtering

  • Endpoint daftar mendukung paginasi berbasis cursor atau token
  • Filter berdasarkan kanal, workflow, status, versi kebijakan, dan rentang waktu
  • Utamakan jendela berbatas untuk ekspor telemetri besar

Model error

  • Kategori error bertipe untuk kegagalan validasi, otorisasi, kebijakan, dan eksekusi
  • Kode alasan mendukung penanganan deterministik di tooling operator
  • Correlation ID dikembalikan untuk investigasi lintas layanan

Contoh permintaan

Buat WorkItem dari payload intake

Buat catatan kerja kanonis untuk pemrosesan workflow. Sertakan pengenal kanal untuk kanal intake jika diperlukan.

Request
curl -X POST "https://api.threada.ai/work-items" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{\"workflow_id\":\"policy_review\",\"channel_id\":\"web_main\",\"payload\":{\"message\":\"Review this renewal request before approval\"}}"
Response
{
  "work_item_id": "wi_123",
  "status": "new",
  "workflow_id": "policy_review"
}

Jalankan tindakan yang disetujui

Jalankan tindakan yang disetujui kebijakan terhadap integrasi yang dikonfigurasi.

Request
curl -X POST "https://api.threada.ai/actions/execute" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d "{\"work_item_id\":\"wi_123\",\"action_id\":\"request_approval\",\"integration_id\":\"int_workflow\"}"
Response
{
  "execution_id": "ex_456",
  "status": "started",
  "idempotency_key": "idem_789"
}

Perlu panduan implementasi?

Gunakan docs dan ikhtisar teknis untuk pola rollout dan tata kelola.

Hubungi tim teknis