Passer au contenu principal
POST
/
v1
/
workflows
/
{workflow_id}
/
run
curl -X POST "https://agents-api.prod.dng.ai/api/v1/workflows/$WORKFLOW_ID/run" \
          --header "x-api-key: $YOUR_API_KEY" \
          --header "content-Type: application/json" \
          --data \
        '{
    "inputs": {
      "Text_0": {
        "value": "Hello world",
        "type": "text"
      }
    }
}'

{
  "success": true,
  "data": {
    "id": "0cf35172-859e-4b26-8ce9-6c2588a77b40",
    "message": "Workflow is running in the background."
  }
}
L’API Workflows vous permet de déclencher l’exécution d’un workflow en arrière-plan. Cet endpoint est utile pour exécuter des workflows selon un planning ou lorsqu’un événement se produit. Une fois l’exécution du workflow créée, elle s’exécute de manière asynchrone et vous recevez une réponse immédiatement.

​
Pendant l’exécution du workflow

L’exécution du workflow est générée en arrière-plan. Vous pouvez vérifier le statut de l’exécution en interrogeant l’endpoint Obtenir une exécution de workflow.

​
En-têtes

​
x-api-key
string
requis
Votre clé API unique pour l’authentification.Cette clé est requise dans l’en-tête de toutes les requêtes API, pour authentifier votre compte et accéder aux services de Draft & Goal. Obtenez votre clé API depuis le Draft & Goal Studio.

​
Paramètres de chemin

​
workflow_id
string
requis
L’identifiant du workflow que vous souhaitez exécuter.

​
Corps

​
inputs
object
requis
Un objet contenant les paramètres d’entrée du workflow. Chaque clé de cet objet représente un ID de node d’entrée de votre workflow.
Vous pouvez obtenir les ID des nodes d’entrée dans les paramètres d’entrée du Workflow Builder du Draft & Goal Studio.
Les inputs sont requis. Pour exécuter un workflow sans paramètres d’entrée, vous pouvez transmettre un objet vide.
​
inputs.*.value
string
requis
La valeur à transmettre au node d’entrée
​
inputs.*.type
string
requis
Le type de la valeur d’entrée. Valeurs possibles : “text”
  {
    "inputs": {
      "Text_0": {
        "value": "Hello, world!",
        "type": "text"
      }
    }
  }

​
Réponse

​
success
boolean
requis
Indique si l’exécution du workflow a réussi.
​
data
object
requis
Les données renvoyées par le démarrage de l’exécution du workflow.
{
  "success": true,
  "data": {
    "id": "0cf35172-859e-4b26-8ce9-6c2588a77b40",
    "message": "Workflow is running in the background."
  }
}

curl -X POST "https://agents-api.prod.dng.ai/api/v1/workflows/$WORKFLOW_ID/run" \
          --header "x-api-key: $YOUR_API_KEY" \
          --header "content-Type: application/json" \
          --data \
        '{
    "inputs": {
      "Text_0": {
        "value": "Hello world",
        "type": "text"
      }
    }
}'