Bỏ qua đến nội dung

Tham chiếu API

Tham chiếu cho các thao tác WorkItem, kiểm soát bước quyết định, thực thi tích hợp và xuất telemetry.

Các API này được thiết kế cho hành vi tự động hóa dự đoán được, với chính sách và giới hạn phạm vi tenant rõ ràng.

Endpoint cơ sở

Dùng endpoint API công khai đã cấu hình của bạn cho các yêu cầu đã xác thực.

https://api.threada.ai

Xác thực và ngữ cảnh

  • Dùng thông tin xác thực có phạm vi để truy cập API
  • Kèm theo ngữ cảnh tenant và vai trò khi được yêu cầu
  • Các yêu cầu thiếu ngữ cảnh hợp lệ sẽ bị từ chối theo mặc định an toàn

Các phạm vi thường gặp

  • workitems:read và workitems:write
  • workflow:manage cho cập nhật chính sách và quyết định
  • actions:execute cho thực thi được quản trị
  • telemetry:read cho xuất dữ liệu và phân tích

Phân trang và lọc

  • Các endpoint danh sách hỗ trợ phân trang theo cursor hoặc token
  • Lọc theo kênh, quy trình, trạng thái, phiên bản chính sách và khoảng thời gian
  • Ưu tiên các khung thời gian có giới hạn cho việc xuất telemetry lớn

Mô hình lỗi

  • Các danh mục lỗi có kiểu cho lỗi xác thực, ủy quyền, chính sách và thực thi
  • Mã lý do hỗ trợ xử lý xác định trong công cụ dành cho operator
  • ID tương quan được trả về để điều tra liên dịch vụ

Yêu cầu ví dụ

Tạo một WorkItem từ payload tiếp nhận

Tạo một bản ghi công việc chuẩn để xử lý quy trình. Kèm định danh kênh cho kênh tiếp nhận khi được yêu cầu.

Yêu cầu 
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\"]}"
Phản hồi 
{
  "work_item": {
    "summary": {
      "work_item_id": "wi_123",
      "status": "new",
      "subject": "Review renewal request"
    }
  }
}

Thực thi một hành động đã được phê duyệt

Chạy một hành động đã được chính sách phê duyệt đối với một tích hợp đã cấu hình.

Yêu cầu 
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}\"}}"
Phản hồi 
{
  "action": {
    "action_id": "act_456",
    "work_item_id": "wi_123",
    "action_type": "custom_http",
    "status": "completed"
  }
}

Hiện vật mẫu

Các ví dụ minh họa về những đối tượng mà Threada tạo ra, với dữ liệu tổng hợp — không phải khách hàng hay bản ghi thật. Tên trường tuân theo lược đồ API và kiểm toán của Threada.

Cần hướng dẫn triển khai?

Dùng tài liệu và bản tổng quan kỹ thuật để biết các mẫu triển khai và quản trị.

Liên hệ đội kỹ thuật