Zum Inhalt springen

API-Referenz

Referenz für WorkItem-Operationen, Entscheidungsschrittkontrollen, Integrationsausführung und Telemetrieexport.

Diese APIs sind für vorhersehbares Automatisierungsverhalten mit expliziter Richtlinien- und Mandantenbereichsbestimmung konzipiert.

Basisendpunkt

Verwenden Sie Ihren konfigurierten öffentlichen API-Endpunkt für authentifizierte Anfragen.

https://api.threada.ai

Authentifizierung und Kontext

  • Verwenden Sie bereichsbezogene Anmeldeinformationen für den API-Zugriff
  • Beziehen Sie bei Bedarf Mandanten- und Rollenkontext ein
  • Anfragen ohne gültigen Kontext schlagen beim Schließen fehl

Typische Bereiche

  • workitems:read und workitems:write
  • workflow:manage für Richtlinien- und Entscheidungsaktualisierungen
  • actions:execute für die kontrollierte Ausführung
  • telemetry:read für Exporte und Analysen

Paginierung und Filterung

  • Listenendpunkte unterstützen die Cursor- oder Token-basierte Paginierung
  • Filtern Sie nach Kanal, Workflow, Status, Richtlinienversion und Zeitraum
  • Bevorzugen Sie begrenzte Fenster für große Telemetrieexporte

Fehlermodell

  • Typisierte Fehlerkategorien für Validierungs-, Autorisierungs-, Richtlinien- und Ausführungsfehler
  • Ursachencodes unterstützen die deterministische Handhabung in Bedienerwerkzeugen
  • Korrelations-IDs werden zur dienstübergreifenden Untersuchung zurückgegeben

Beispielanfragen

Erstellen Sie ein WorkItem aus der Aufnahmenutzlast

Erstellen Sie einen kanonischen Arbeitsdatensatz für die Workflow-Verarbeitung. Geben Sie bei Bedarf die Kanalkennung für den Einlasskanal an.

Anfrage 
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\"}}"
Antwort 
{
  "work_item_id": "wi_123",
  "status": "new",
  "workflow_id": "policy_review"
}

Führen Sie eine genehmigte Aktion aus

Führen Sie eine von der Richtlinie genehmigte Aktion für eine konfigurierte Integration aus.

Anfrage 
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\"}"
Antwort 
{
  "execution_id": "ex_456",
  "status": "started",
  "idempotency_key": "idem_789"
}

Benötigen Sie eine Anleitung zur Umsetzung?

Nutzen Sie die Dokumente und die technische Übersicht für Rollout- und Governance-Muster.

Kontaktieren Sie das technische Team