Aller au contenu

Référence API

Référence pour les opérations WorkItem, les contrôles d'étape de décision, l'exécution des intégrations et l'export de télémétrie.

Ces API sont conçues pour un comportement d'automatisation prévisible avec un cadrage explicite des politiques et du tenant.

Point de terminaison de base

Utilisez votre point de terminaison API public configuré pour les requêtes authentifiées.

https://api.threada.ai

Authentification et contexte

  • Utilisez des identifiants à portée limitée pour l'accès à l'API
  • Incluez le contexte du tenant et du rôle lorsque c'est requis
  • Les requêtes sans contexte valide échouent en mode fermé

Portées typiques

  • workitems:read et workitems:write
  • workflow:manage pour les mises à jour de politiques et de décisions
  • actions:execute pour l'exécution gouvernée
  • telemetry:read pour les exports et l'analyse

Pagination et filtrage

  • Les points de terminaison de liste prennent en charge la pagination par curseur ou par jeton
  • Filtrez par canal, flux de travail, statut, version de politique et plage temporelle
  • Privilégiez des fenêtres bornées pour les exports volumineux de télémétrie

Modèle d'erreur

  • Catégories d'erreurs typées pour les échecs de validation, d'autorisation, de politique et d'exécution
  • Les codes de raison permettent une gestion déterministe dans l'outillage des opérateurs
  • Des identifiants de corrélation sont renvoyés pour les investigations interservices

Exemples de requêtes

Créer un WorkItem à partir d'une charge utile d'admission

Créez un enregistrement de travail canonique pour le traitement du flux de travail. Incluez l'identifiant du canal d'admission lorsque c'est requis.

Requête
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\"]}"
Réponse
{
  "work_item": {
    "summary": {
      "work_item_id": "wi_123",
      "status": "new",
      "subject": "Review renewal request"
    }
  }
}

Exécuter une action approuvée

Exécutez une action approuvée par la politique sur une intégration configurée.

Requête
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}\"}}"
Réponse
{
  "action": {
    "action_id": "act_456",
    "work_item_id": "wi_123",
    "action_type": "custom_http",
    "status": "completed"
  }
}

Exemples d'artefacts

Exemples illustratifs des objets que Threada produit, avec des données synthétiques — ni clients ni enregistrements réels. Les noms de champs suivent les schémas d'API et d'audit de Threada.

Besoin de conseils de mise en œuvre ?

Utilisez la documentation et l'aperçu technique pour les modèles de déploiement et de gouvernance.

Contacter l'équipe technique