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 fehlersicher fehl

Typische Bereiche

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

Paginierung und Filterung

  • Listenendpunkte unterstützen 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 Operator-Werkzeugen
  • Korrelations-IDs werden zur dienstübergreifenden Untersuchung zurückgegeben

Beispielanfragen

Ein WorkItem aus der Eingangs-Nutzlast erstellen

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

Anfrage 
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\"]}"
Antwort 
{
  "work_item": {
    "summary": {
      "work_item_id": "wi_123",
      "status": "new",
      "subject": "Review renewal request"
    }
  }
}

Eine genehmigte Aktion ausführen

Führen Sie eine richtlinienkonform genehmigte Aktion für eine konfigurierte Integration aus.

Anfrage 
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}\"}}"
Antwort 
{
  "action": {
    "action_id": "act_456",
    "work_item_id": "wi_123",
    "action_type": "custom_http",
    "status": "completed"
  }
}

Beispiel-Artefakte

Veranschaulichende Beispiele der Objekte, die Threada erzeugt, mit synthetischen Daten — keine echten Kunden oder Datensätze. Die Feldnamen folgen den API- und Audit-Schemas von Threada.

Benötigen Sie eine Anleitung zur Umsetzung?

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

Technisches Team kontaktieren