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 kończą się 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 obsługują 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/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\"}}"
Odpowiedź 
{
  "work_item_id": "wi_123",
  "status": "new",
  "workflow_id": "policy_review"
}

Wykonaj zatwierdzone działanie

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

Żądanie 
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\"}"
Odpowiedź 
{
  "execution_id": "ex_456",
  "status": "started",
  "idempotency_key": "idem_789"
}

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