DĂ©clencheur d'API
DĂ©marrez un flux de travail Ă partir d'une requĂȘte HTTP authentifiĂ©e
Aperçu
Le déclencheur d'API expose votre flux de travail en tant que point de terminaison HTTP sécurisé. Envoyez des données JSON au point de terminaison et votre flux de travail les traite immédiatement. Les appels API s'exécutent toujours sur votre dernier déploiement.
Configurer le format d'entrée
Ajoutez un champ Format d'entrée pour chaque paramÚtre. Les clés de sortie d'exécution reflÚtent le schéma et sont également disponibles sous <api.input>.
- type: string
name: userId
value: demo-user # optional manual test value
- type: number
name: maxTokensLes exĂ©cutions manuelles dans l'Ă©diteur utilisent la colonne value pour que vous puissiez tester sans envoyer de requĂȘte. Pendant l'exĂ©cution, le rĂ©solveur remplit Ă la fois <api.userId> et <api.input.userId>.
Exemple de requĂȘte
curl -X POST \
https://sim.ai/api/workflows/WORKFLOW_ID/execute \
-H 'Content-Type: application/json' \
-H 'X-API-Key: YOUR_KEY' \
-d '{"userId":"demo-user","maxTokens":1024}'Les réponses réussies renvoient le résultat d'exécution sérialisé de l'Exécuteur. Les erreurs révÚlent des problÚmes de validation, d'authentification ou d'échec du flux de travail.
Référence de sortie
| Référence | Description |
|---|---|
<api.field> | Champ défini dans le Format d'entrée |
<api.input> | Corps de la requĂȘte structurĂ© complet |
Si aucun Format d'entrée n'est défini, l'exécuteur expose le JSON brut uniquement à <api.input>.
Un flux de travail ne peut contenir qu'un seul déclencheur d'API. Publiez un nouveau déploiement aprÚs les modifications pour que le point de terminaison reste à jour.