Récupérer une exécution de workflow

Récupérer les détails d'une exécution de workflow spécifique

L’API Exécutions de workflow permet de récupérer les détails d’une exécution.

En-têtes

string required

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 tableau de bord Draft & Goal.

Paramètres de chemin

run_id string required

L’ID de l’exécution de workflow que vous souhaitez récupérer.

Paramètres de requête

all_completed_steps boolean default: false

Indique si la réponse doit inclure toutes les étapes terminées.

La valeur par défaut est false.

Pendant l’exécution du workflow

Si l’exécution du workflow est encore en cours, vous recevrez un code de statut HTTP 250. Veuillez patienter quelques minutes et interroger à nouveau l’endpoint.

Réponse

success boolean required

Indique si l’exécution du workflow a réussi.

data object required

Les données renvoyées par l’exécution du workflow.

Structure des données

run_id string required

L’ID de l’exécution du workflow.

workflow_id string required

L’ID du workflow qui a été exécuté.

inputs object required

Les entrées de l’exécution du workflow.

Chaque clé de cet objet représente un ID de node d’entrée de votre workflow.

Structure des paramètres d'entrée

inputs.*.value string required

La valeur du paramètre d’entrée.

inputs.*.type string required

Le type de la valeur d’entrée. Valeurs possibles : “text”

state string required

L’état de l’exécution du workflow.

Options disponibles : DONE, FAILED, USER_ABORTED

error string

L’erreur survenue pendant l’exécution du workflow.

started_at string

La date et l’heure de début de l’exécution du workflow.

ended_at string

La date et l’heure de fin de l’exécution du workflow.

completed_steps object[] required

Les étapes qui ont été terminées pendant l’exécution du workflow.

Tip

Vous pouvez utiliser l’ID du node d’une étape pour sélectionner une étape spécifique et récupérer la sortie.

Structure d'une étape terminée

stepId string required

L’ID de l’étape.

nodeId string required

L’ID du node.

state string required

L’état de l’étape.

Option disponible : DONE

downloadable_output boolean required

Indique si l’étape possède une sortie téléchargeable.

output string | null required

La sortie de l’étape si celle-ci possède une sortie téléchargeable.

started_at string | null required

La date et l’heure de début de l’étape.

ended_at string | null required

La date et l’heure de fin de l’étape.

failed_steps object[] required

Les étapes qui ont échoué ou ont été interrompues pendant l’exécution du workflow.

Structure d'une étape en échec

step_id string required

L’ID de l’étape.

node_id string required

L’ID du node. Vous pouvez utiliser cet ID pour sélectionner un node spécifique et récupérer la sortie.

state string required

L’état de l’étape.

Options disponibles : FAILED, USER_ABORTED

error string required

L’erreur survenue pendant l’étape.

started_at string | null required

La date et l’heure de début de l’étape.

ended_at string | null required

La date et l’heure de fin de l’étape.

Response Example

{
  "success": true,
  "data": {
    "run_id": "0cf35172-859e-4b26-8ce9-6c2588a77b40",
    "workflow_id": "ab44401b-6947-46bc-8248-47aa2dacf856",
    "inputs": {
      "Text_0": {
        "value": "Hello world",
        "type": "text"
      }
    },
    "state": "DONE",
    "error": null,
    "started_at": "2025-02-17T13:33:45.575000",
    "ended_at": "2025-02-17T13:36:17.194000",
    "completed_steps": [
      {
        "step_id": "ee7d2258-8ff5-4176-8498-110f8dc8d264",
        "node_id": "LLM_0",
        "state": "DONE",
        "downloadable_output": true,
        "output": "Example output",
        "started_at": "2025-02-17T13:33:45.575000",
        "ended_at": "2025-02-17T13:34:17.194000"
      },
      {
        "step_id": "d5c913ab-0970-49f3-955a-eee4b2447276",
        "node_id": "LLM_1",
        "state": "DONE",
        "downloadable_output": false,
        "output":null,
        "started_at": "2025-02-17T13:35:45.575000",
        "ended_at": "2025-02-17T13:36:17.194000"
      }
    ],
    "failed_steps": []
  }
}

{
  "message": "Génération de l'exécution du workflow en cours. Veuillez patienter quelques minutes."
}

{
  "type": "error",
  "error": {
    "message": "Vous n'avez pas accès à cette exécution de workflow"
  }
}

{
  "type": "error",
  "error": {
    "message": "ID d'exécution invalide | Exécution supprimée"
  }
}

Request Example

curl "https://agents-api.prod.dng.ai/api/v1/workflow-runs/$WORKFLOW_RUN_ID" \
          --header "x-api-key: $YOUR_API_KEY" \
          --header "content-Type: application/json"