Przejdź do treści

Dokumentacja API

Dokumentacja operacji WorkItem, kontroli kroków decyzyjnych, wykonania integracji i eksportu telemetrii.

Te API są zaprojektowane dla przewidywalnego zachowania automatyzacji z jawnym zakresowaniem zasad i tenantów.

Bazowy endpoint

Użyj skonfigurowanego publicznego endpointu API do uwierzytelnionych żądań.

https://api.threada.ai

Uwierzytelnianie i kontekst

  • Używaj poświadczeń o określonym zakresie do dostępu API
  • Uwzględniaj kontekst tenanta i roli tam, gdzie jest wymagany
  • Żądania bez prawidłowego kontekstu są domyślnie odrzucane (fail-closed)

Typowe zakresy

  • workitems:read i workitems:write
  • workflow:manage do aktualizacji zasad i decyzji
  • actions:execute do kontrolowanego wykonywania
  • telemetry:read do eksportów i analizy

Paginacja i filtrowanie

  • Endpointy list obsługują paginację opartą na kursorach lub tokenach
  • Filtruj według kanału, przepływu pracy, statusu, wersji zasad i zakresu czasu
  • Preferuj ograniczone okna dla dużych eksportów telemetrii

Model błędów

  • Typowane kategorie błędów dla walidacji, autoryzacji, zasad i błędów wykonania
  • Kody powodów umożliwiają deterministyczną obsługę w narzędziach operatora
  • Identyfikatory korelacji są zwracane do dochodzeń między usługami

Przykładowe żądania

Utwórz WorkItem z payloadu przyjmowania

Utwórz kanoniczny rekord pracy do przetwarzania przepływu pracy. Uwzględnij identyfikator kanału dla kanału przyjmowania, gdy jest wymagany.

Żądanie 
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\"]}"
Odpowiedź 
{
  "work_item": {
    "summary": {
      "work_item_id": "wi_123",
      "status": "new",
      "subject": "Review renewal request"
    }
  }
}

Wykonaj zatwierdzone działanie

Uruchom działanie zatwierdzone przez zasady względem skonfigurowanej integracji.

Żądanie 
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}\"}}"
Odpowiedź 
{
  "action": {
    "action_id": "act_456",
    "work_item_id": "wi_123",
    "action_type": "custom_http",
    "status": "completed"
  }
}

Przykładowe artefakty

Poglądowe przykłady obiektów, które tworzy Threada, z danymi syntetycznymi — nie są to prawdziwi klienci ani rekordy. Nazwy pól są zgodne ze schematami API i audytu Threada.

Potrzebujesz wskazówek implementacyjnych?

Użyj dokumentów i przeglądu technicznego do wzorców rollout'u i ładu.

Skontaktuj się z zespołem technicznym