Get a Workflow Results

Retrieve the results of the workflow and it's steps

See workflow results

Get all previous runs

To get the list of all previous workflow runs, use the get workflow runs endpoint:

Get Detail Run Tasks

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

bot_idany ofOptional

stringOptional

or

nullOptional

statusany ofOptional

stringOptional

or

nullOptional

workflow_idany ofOptional

stringOptional

or

nullOptional

pageintegerOptionalDefault: 1

sizeintegerOptionalDefault: 20

sort_byany ofOptionalDefault: createdAt

stringOptional

or

nullOptional

sort_orderany ofOptionalDefault: desc

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/cortex/executor/get-detail-run-tasks

HTTPcURLJavaScriptPython

GET /cortex/executor/get-detail-run-tasks HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalCount": 1,
  "currentPage": 1,
  "data": [
    {
      "_id": "text",
      "createdAt": "2025-12-09T10:40:41.903Z",
      "modifiedAt": "2025-12-09T10:40:41.903Z",
      "botId": "",
      "botName": "",
      "isDeletedBot": false,
      "convoId": "",
      "convoName": "",
      "isDeletedConvo": false,
      "userId": "",
      "workflowId": "",
      "currentWorkflowStepId": "text",
      "status": "running",
      "finishAt": "",
      "noteId": "text",
      "targetConvoId": "text",
      "knowledgeBases": [
        "text"
      ],
      "runMode": "run_all_step",
      "jobId": "text",
      "autoAdvance": true,
      "workflow": {
        "_id": "text",
        "createdAt": "2025-12-09T10:40:41.903Z",
        "modifiedAt": "2025-12-09T10:40:41.903Z",
        "botId": "text",
        "name": "text",
        "description": "text"
      }
    }
  ]
}

Example response:

{
  "code": 200,
  "key": null,
  "body": {
    "totalCount": 2,
    "currentPage": 1,
    "data": [
      {
        "_id": "6791f15445000764f4e5c7ff",
        "createdAt": "2025-01-23T07:35:48.855802",
        "modifiedAt": "2025-01-23T07:40:11.509807",
        "botId": "65f94c6a943fe0514752412d",
        "botName": "Cortex mobile",
        "convoId": "6757fb9ef7ecf43679ef2e72",
        "convoName": "New Data Room",
        "workflowId": "670620c9276af9d8a7eab0e1",
        "status": "success",
        "finishAt": "2025-01-23T07:40:11.441650"
      },
      {
        "_id": "6790a37635f1063e4a2284d9",
        "createdAt": "2025-01-22T07:51:18.886326",
        "modifiedAt": "2025-01-23T07:35:40.185545",
        "botId": "65f94c6a943fe0514752412d",
        "botName": "Cortex mobile",
        "convoId": "6757fb9ef7ecf43679ef2e72",
        "convoName": "New Data Room",
        "workflowId": "668e3c20aab00720ed055c3e",
        "status": "stop",
        "finishAt": null
      }
    ]
  }
}

See details of a workflow run

To get the details of a specific workflow run, use the following endpoint:

Get Workflow By Run Task Id

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

run_task_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/cortex/executor/get-workflow-by-run-task-id/{run_task_id}

HTTPcURLJavaScriptPython

GET /cortex/executor/get-workflow-by-run-task-id/{run_task_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "text",
  "createdAt": "2025-12-09T10:40:41.903Z",
  "modifiedAt": "2025-12-09T10:40:41.903Z",
  "botId": "text",
  "name": "text",
  "description": "text",
  "isDefault": false,
  "runModeDefault": "run_all_step",
  "isDefaultContext": false,
  "workflowSteps": [
    {
      "workflowId": "text",
      "stepType": "prompt",
      "name": "text",
      "runModeDefault": "run_all_step",
      "apiUrl": "https://example.com",
      "attachPreviousStepOutput": false,
      "auth": {
        "type": "basic",
        "username": "text",
        "password": "text"
      },
      "headers": [
        {
          "key": "text",
          "value": "text",
          "isActive": true
        }
      ],
      "payload": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "queryParams": [
        {
          "key": "text",
          "value": "text",
          "isActive": true
        }
      ],
      "method": "GET",
      "timeout": 10,
      "retries": 3,
      "_id": "text",
      "createdAt": "2025-12-09T10:40:41.903Z",
      "modifiedAt": "2025-12-09T10:40:41.903Z"
    }
  ]
}

The response will provide the details of the workflow run, including the status, start time, and end time, and the list of steps that were executed.

Example response:

{
  "code": 200,
  "key": null,
  "body": {
    "_id": "668e3c20aab00720ed055c3e",
    "createdAt": "2024-07-10T07:45:36.023662",
    "modifiedAt": "2025-01-14T13:34:05.213017",
    "botId": "65c38e71d42e8f8525efdba6",
    "name": "Patentsx",
    "description": "This is a descriptionx",
    "isDefault": false,
    "runModeDefault": "run_all_step",
    "workflowSteps": [
      {
        "_id": "668e3c20aab00720ed055c3f",
        "workflowId": "668e3c20aab00720ed055c3e",
        "stepType": "prompt",
        "name": "ExtractionExtractionExtraction",
        "model": "anthropic-claude-v3.5-sonnet",
        "createdAt": "2025-01-14T13:34:05.258280",
        "modifiedAt": "2025-01-14T13:34:05.258280"
      },
      {
        "_id": "66e403afc306cc9303dab10f",
        "workflowId": "668e3c20aab00720ed055c3e",
        "stepType": "prompt",
        "name": "Step 2",
        "model": "gpt-4-1106-preview",
        "createdAt": "2025-01-14T13:34:05.277285",
        "modifiedAt": "2025-01-14T13:34:05.277285"
      },
      {
        "_id": "66e403c0c306cc9303dab11b",
        "workflowId": "668e3c20aab00720ed055c3e",
        "stepType": "prompt",
        "name": "Step 3",
        "model": "gpt-4-1106-preview",
        "createdAt": "2025-01-14T13:34:05.296197",
        "modifiedAt": "2025-01-14T13:34:05.296197"
      },
      {
        "_id": "66e403e99ad63ccc3e19b1ca",
        "workflowId": "668e3c20aab00720ed055c3e",
        "stepType": "prompt",
        "name": "Step 4",
        "model": "gpt-4-1106-preview",
        "createdAt": "2025-01-14T13:34:05.314108",
        "modifiedAt": "2025-01-14T13:34:05.314109"
      },
      {
        "_id": "66e403fe9ad63ccc3e19b1db",
        "workflowId": "668e3c20aab00720ed055c3e",
        "stepType": "prompt",
        "name": "Step 5",
        "model": "gpt-4-1106-preview",
        "createdAt": "2025-01-14T13:34:05.332110",
        "modifiedAt": "2025-01-14T13:34:05.332111"
      }
    ]
  }
}

See results of a workflow step

The output of each step can be accessed using the get step result endpoint:

Get Workflow Step Output

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

run_task_idstringRequired

step_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/cortex/executor/get-workflow-step-output/{run_task_id}/{step_id}

HTTPcURLJavaScriptPython

GET /cortex/executor/get-workflow-step-output/{run_task_id}/{step_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "stepOutput": {
    "_id": "text",
    "createdAt": "2025-12-09T10:40:41.903Z",
    "modifiedAt": "2025-12-09T10:40:41.903Z",
    "botId": "",
    "convoId": "",
    "convoName": "text",
    "runTaskId": "",
    "content": "text",
    "prompt": "text",
    "langfuseUrl": "",
    "messageId": "",
    "selectedWorkflowId": "",
    "selectedWorkflowStepId": "",
    "status": "success",
    "noteId": "text",
    "model": "gpt-3.5-turbo",
    "referMessageId": "",
    "referContent": "",
    "knowledgeBases": [
      "text"
    ],
    "stepContext": {
      "workflowId": "",
      "workflowStepId": "",
      "contexts": [
        {
          "convoId": "text",
          "convoName": "text",
          "previousStepIds": [
            "text"
          ],
          "type": "convo"
        }
      ]
    },
    "error": "text",
    "webSearchQuery": "text",
    "webRef": [
      {
        "query": "text",
        "answer": [
          {
            "id": "text",
            "url": "text",
            "content": "text",
            "title": "text"
          }
        ]
      }
    ],
    "webProRef": [
      {
        "question": "text",
        "search_queries": [
          {
            "query": "text",
            "answer": [
              {
                "id": "text",
                "url": "text",
                "content": "text",
                "title": "text"
              }
            ]
          }
        ]
      }
    ],
    "isWebProR": false,
    "webSearchConfig": {
      "webSearchProvider": "linkup_normal_web_search",
      "isLinkupDeepSearch": false
    },
    "responseMessage": {
      "_id": "text",
      "createdAt": "2025-12-09T10:40:41.903Z",
      "modifiedAt": "2025-12-09T10:40:41.903Z",
      "botId": "text",
      "userId": "text",
      "convoId": "text",
      "content": "text",
      "role": "text",
      "model": "gpt-3.5-turbo",
      "messageType": "assistant-greeting",
      "status": "activate",
      "langfuseUrl": "",
      "currentContent": "text",
      "uploadedFiles": [
        {
          "_id": "text",
          "createdAt": "2025-12-09T10:40:41.903Z",
          "modifiedAt": "2025-12-09T10:40:41.903Z",
          "name": "text",
          "key": "text",
          "tokens": 0,
          "enabled": true,
          "errorMessage": "text",
          "status": "SUCCESS",
          "calculatedStatus": "SUCCESS",
          "convoId": "",
          "fileType": "TEXT",
          "fileSize": 0,
          "imageDescription": "",
          "imageWidth": 1,
          "imageHeight": 1,
          "userId": "text",
          "imageResizeKey": "text",
          "imageThumbKey": "text",
          "zipAttachmentId": "text"
        }
      ],
      "isSaved": false,
      "noteId": "text",
      "insightsGraphType": "STATUS_QUO",
      "doc_ref": [
        {
          "doc_id": "text",
          "doc_name": "text",
          "text_id": [
            {
              "content": "text",
              "text_id": "text",
              "score": 0,
              "isRelatedChunk": false,
              "doc_type": "vector-db"
            }
          ],
          "originalUrl": "text",
          "score": 0,
          "doc_type": "vector-db",
          "isTemplate": false,
          "imageResizeKey": "text",
          "imageThumbKey": "text"
        }
      ],
      "webSearchQuery": "text",
      "webRef": [
        {
          "query": "text",
          "answer": [
            {
              "id": "text",
              "url": "text",
              "content": "text",
              "title": "text"
            }
          ]
        }
      ],
      "webProRef": [
        {
          "question": "text",
          "search_queries": [
            {
              "query": "text",
              "answer": [
                {
                  "id": "text",
                  "url": "text",
                  "content": "text",
                  "title": "text"
                }
              ]
            }
          ]
        }
      ],
      "isWebProR": false,
      "webSearchConfig": {
        "webSearchProvider": "linkup_normal_web_search",
        "isLinkupDeepSearch": false
      },
      "standaloneQuestion": "text",
      "relatedChunkIds": [
        "text"
      ],
      "targetText": "text",
      "targetMessageId": "text",
      "targetFullContent": "text",
      "messageReplies": [
        "text"
      ],
      "isUnliked": true,
      "feedbackAt": "2025-12-09T10:40:41.903Z",
      "feedbackContent": "text",
      "selectedWorkflowId": "",
      "workflow": {
        "runTaskId": "",
        "workflowId": "",
        "workflowName": "",
        "stepId": "",
        "stepName": ""
      },
      "selectedAgentTask": {
        "_id": "text",
        "createdAt": "2025-12-09T10:40:41.903Z",
        "modifiedAt": "2025-12-09T10:40:41.903Z",
        "category_id": "text",
        "name": "text",
        "type": "custom",
        "description": "text",
        "category": {
          "_id": "text",
          "createdAt": "2025-12-09T10:40:41.903Z",
          "modifiedAt": "2025-12-09T10:40:41.903Z",
          "icon": "text",
          "name": "text",
          "owner": "text",
          "count": 1,
          "isPublic": false,
          "isTemplate": false
        },
        "isFavorite": false,
        "isSelected": false,
        "isActive": false,
        "categoryName": "text"
      },
      "selectedStrategy": "",
      "selectedAction": "",
      "strategies": [
        {
          "name": "text",
          "slug": "",
          "description": "",
          "icon": "",
          "actions": [
            {
              "name": "text",
              "slug": "",
              "prompt": "",
              "description": "",
              "icon": "",
              "isDefault": true
            }
          ],
          "scopes": [
            "scope-user"
          ],
          "isDefault": true
        }
      ],
      "targetSelectedStrategy": "",
      "targetSelectedAction": "",
      "targetAgentTask": {
        "_id": "text",
        "createdAt": "2025-12-09T10:40:41.903Z",
        "modifiedAt": "2025-12-09T10:40:41.903Z",
        "category_id": "text",
        "name": "text",
        "type": "custom",
        "description": "text",
        "category": {
          "_id": "text",
          "createdAt": "2025-12-09T10:40:41.903Z",
          "modifiedAt": "2025-12-09T10:40:41.903Z",
          "icon": "text",
          "name": "text",
          "owner": "text",
          "count": 1,
          "isPublic": false,
          "isTemplate": false
        },
        "isFavorite": false,
        "isSelected": false,
        "isActive": false,
        "categoryName": "text"
      },
      "promptMessageId": "",
      "messageQueryId": "text",
      "mediaUrls": [
        {
          "contentType": "text",
          "url": "text"
        }
      ]
    },
    "docRef": [
      {
        "doc_id": "text",
        "doc_name": "text",
        "text_id": [
          {
            "content": "text",
            "text_id": "text",
            "score": 0,
            "isRelatedChunk": false,
            "doc_type": "vector-db"
          }
        ],
        "isDownloadable": false,
        "originalUrl": "text",
        "thumbUrl": "text",
        "score": 0,
        "doc_type": "vector-db",
        "prompt": "text",
        "url": "text",
        "status": "SUCCESS",
        "kb_filetype": "text",
        "docExist": true,
        "havePermission": true,
        "breadcrumb": "text",
        "isExtractedZipFileSharepoint": false
      }
    ],
    "uploadedFiles": [
      {
        "_id": "text",
        "createdAt": "2025-12-09T10:40:41.903Z",
        "modifiedAt": "2025-12-09T10:40:41.903Z",
        "name": "text",
        "key": "text",
        "tokens": 0,
        "enabled": true,
        "errorMessage": "text",
        "status": "SUCCESS",
        "calculatedStatus": "SUCCESS",
        "convoId": "",
        "fileType": "TEXT",
        "fileSize": 0,
        "imageDescription": "",
        "imageWidth": 1,
        "imageHeight": 1,
        "userId": "text",
        "imageResizeKey": "text",
        "imageThumbKey": "text",
        "zipAttachmentId": "text"
      }
    ],
    "isCompanyGpt": false
  },
  "runTask": {
    "workflowId": "",
    "runMode": "text",
    "currentWorkflowStepId": "text",
    "status": "running",
    "finishAt": "text",
    "noteId": "text",
    "targetConvoId": "text",
    "knowledgeBases": [
      "text"
    ],
    "workflow": {
      "_id": "text",
      "createdAt": "2025-12-09T10:40:41.903Z",
      "modifiedAt": "2025-12-09T10:40:41.903Z",
      "botId": "text",
      "name": "text",
      "description": "text",
      "isDefault": false,
      "runModeDefault": "run_all_step",
      "isDefaultContext": false,
      "workflowSteps": [
        {
          "workflowId": "text",
          "stepType": "prompt",
          "name": "text",
          "runModeDefault": "run_all_step",
          "apiUrl": "https://example.com",
          "attachPreviousStepOutput": false,
          "auth": {
            "type": "basic",
            "username": "text",
            "password": "text"
          },
          "headers": [
            {
              "key": "text",
              "value": "text",
              "isActive": true
            }
          ],
          "payload": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "queryParams": [
            {
              "key": "text",
              "value": "text",
              "isActive": true
            }
          ],
          "method": "GET",
          "timeout": 10,
          "retries": 3,
          "_id": "text",
          "createdAt": "2025-12-09T10:40:41.903Z",
          "modifiedAt": "2025-12-09T10:40:41.903Z"
        }
      ]
    },
    "jobId": "text",
    "error": "text",
    "autoAdvance": true
  }
}

Example of a step response:

{
  "code": 200,
  "key": null,
  "body": {
    "stepOutput": {
      "_id": "6791f25245000764f4e5c805",
      "createdAt": "2025-01-23T07:40:02.209660",
      "modifiedAt": "2025-01-23T07:40:02.223695",
      "botId": "65f94c6a943fe0514752412d",
      "runTaskId": "6791f15445000764f4e5c7ff",
      "content": "### Client Company's Size and Reach\n\n#### Headquarters\n- **Headquarters Location**: Munich, Germany\n\n#### Countries Serviced\n- **Countries Serviced**: \n  - Germany\n  - United States\n  - China\n  - United Kingdom\n  - France\n  - Italy\n  - Japan\n  - Canada\n  - Australia\n  - Brazil\n\n### Size Based on Number of Employees\n\n#### Employee Count\n- **Number of Employees**: 1,200\n\n#### Categorization\n- **Category**: Corporation (over 1000 employees)\n\n---\n\n**Note**: If further detailed data is required or specific figures are needed, please provide additional context or clarification.\n\n**Timestamp**: Thursday, January 23, 2025 at 08:40 AM CET",
      "selectedWorkflowId": "670620c9276af9d8a7eab0e1",
      "selectedWorkflowStepId": "670620ca276af9d8a7eab0e3",
      "status": "success",
      "model": "azure-gpt-4o",
      "stepContext": {
        "workflowId": "670620c9276af9d8a7eab0e1",
        "workflowStepId": "670620ca276af9d8a7eab0e3",
        "contexts": [
          {
            "convoId": "6757fb9ef7ecf43679ef2e72",
            "convoName": "New Data Room",
            "type": "convo"
          }
        ]
      },
      "error": null,
      "webSearchQuery": null,
      "webRef": []
    }
  }
}

The output content can be extracted from the content field.

Next Step

In order to persist our workflow results, let's Save Workflow Results.