مرجع API
مرجع لعمليات WorkItem وضوابط خطوة القرار وتنفيذ التكامل وتصدير القياس عن بُعد.
صُممت واجهات API هذه لسلوك أتمتة يمكن التنبؤ به مع تحديد صريح لنطاق السياسات والمستأجر.
نقطة النهاية الأساسية
استخدم نقطة نهاية API العامة المهيّأة لديك للطلبات المُصادَق عليها.
https://api.threada.ai المصادقة والسياق
- استخدم بيانات اعتماد محدَّدة النطاق للوصول إلى API
- ضمّن سياق المستأجر والدور عند الحاجة
- تفشل الطلبات التي تفتقر إلى سياق صالح فشلاً مغلقاً
النطاقات النموذجية
- workitems:read و workitems:write
- workflow:manage لتحديثات السياسات والقرارات
- actions:execute للتنفيذ المحكوم
- telemetry:read للتصدير والتحليل
ترقيم الصفحات والتصفية
- تدعم نقاط نهاية القوائم ترقيم الصفحات القائم على المؤشر أو الرمز المميز
- صفِّ حسب القناة وسير العمل والحالة وإصدار السياسة والنطاق الزمني
- فضّل النوافذ المحدودة لعمليات تصدير القياس عن بُعد الكبيرة
نموذج الأخطاء
- فئات أخطاء مُصنَّفة لإخفاقات التحقق من الصحة والترخيص والسياسات والتنفيذ
- تدعم رموز الأسباب المعالجة الحتمية في أدوات المشغّل
- تُرجَع معرّفات الارتباط للتحقيق عبر الخدمات
أمثلة على الطلبات
إنشاء WorkItem من حمولة الاستقبال
أنشئ سجل عمل أساسياً لمعالجة سير العمل. ضمّن معرّف القناة الخاص بقناة الاستقبال عند الحاجة.
الطلب
curl -X POST "https://api.threada.ai/api/v1/public/work-items" \
-H "X-API-Key: <api-key>" \
-H "Content-Type: application/json" \
-d "{\"subject\":\"Review renewal request\",\"channel\":\"web\",\"channel_id\":\"web_main\",\"initial_message\":{\"role\":\"user\",\"content\":\"Review this renewal request before approval\"},\"tags\":[\"policy_review\"]}" الاستجابة
{
"work_item": {
"summary": {
"work_item_id": "wi_123",
"status": "new",
"subject": "Review renewal request"
}
}
} تنفيذ إجراء معتمد
شغّل إجراءً معتمداً بموجب السياسة مقابل تكامل مهيّأ.
الطلب
curl -X POST "https://api.threada.ai/api/v1/public/work-items/wi_123/actions" \
-H "X-API-Key: <api-key>" \
-H "Content-Type: application/json" \
-d "{\"integration_id\":\"int_workflow\",\"idempotency_key\":\"act_456\",\"payload\":{\"type\":\"custom_http\",\"method\":\"POST\",\"url\":\"https://api.example.com/approvals\",\"body_json\":\"{\\\"approved\\\":true}\"}}" الاستجابة
{
"action": {
"action_id": "act_456",
"work_item_id": "wi_123",
"action_type": "custom_http",
"status": "completed"
}
} عيّنات من المخرجات
أمثلة توضيحية للكائنات التي ينتجها Threada، ببيانات اصطناعية — لا عملاء أو سجلات حقيقية. تتبع أسماء الحقول مخططات Threada الخاصة بـ API والتدقيق.
هل تحتاج إلى إرشادات التنفيذ؟
استخدم الوثائق والنظرة العامة الفنية للاطّلاع على أنماط الطرح والحوكمة.
تواصل مع الفريق الفني