Run a Workflow

Run a pre-defined workflow using the API

Get list of existing workflows

Workflows are attached to a workshop bot. The list of existing workflows in a bot are provided via the get workshop bot details endpoint, which require the bot_id. The result you are looking for should be found in the workflows field:

Get Detail Pre Defined Cortex

get

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

bot_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/cortex/bot/detail/{bot_id}

HTTPcURLJavaScriptPython

GET /cortex/bot/detail/{bot_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "text",
  "createdAt": "2025-12-09T10:43:36.828Z",
  "modifiedAt": "2025-12-09T10:43:36.828Z",
  "parentCortexBot": "text",
  "isOwner": false,
  "botTemplate": "nexus",
  "iconSignedUrl": "text",
  "name": "text",
  "systemMessage": "text",
  "defaultGreetings": "text",
  "description": "",
  "isPublic": false,
  "isDefaultBot": false,
  "iconUrl": "text",
  "tags": [
    "text"
  ],
  "followUp": [
    "text"
  ],
  "isEnableInitialQuestions": false,
  "followUpPrompt": "text",
  "elvLabApiKey": "text",
  "voiceId": "text",
  "ttsOption": "text",
  "enableAutoResponse": false,
  "enableVisualRetrieval": false,
  "enableVoiceInput": true,
  "enableInlineCitation": false,
  "isReferencesEnabled": true,
  "searchMethodType": 1,
  "model": "gpt-3.5-turbo",
  "modelsFavorites": [
    "gpt-3.5-turbo"
  ],
  "agentsFavorites": [
    "text"
  ],
  "topk": 1,
  "advanceOptions": {
    "temperature": 0.7,
    "topP": 1,
    "presencePenalty": 0,
    "frequencyPenalty": 0
  },
  "knowledgeBase": "text",
  "contributedDatabase": [
    "text"
  ],
  "strategies": [
    {
      "name": "text",
      "slug": "",
      "description": "",
      "icon": "",
      "actions": [
        {
          "name": "text",
          "slug": "",
          "description": "",
          "icon": "",
          "prompt": "text",
          "isDefault": true
        }
      ],
      "scopes": [
        "scope-user"
      ],
      "isDefault": true
    }
  ],
  "summaryPrompt": "",
  "workflows": [
    {
      "_id": "text",
      "createdAt": "2025-12-09T10:43:36.828Z",
      "modifiedAt": "2025-12-09T10:43:36.828Z",
      "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:43:36.828Z",
          "modifiedAt": "2025-12-09T10:43:36.828Z"
        }
      ]
    }
  ],
  "advancedSetting": {
    "botId": "text",
    "advancedFeatures": [
      {
        "key": "text",
        "isActive": false
      }
    ],
    "actionButtons": [
      {
        "key": "text",
        "isRight": false,
        "index": 1,
        "isActive": false
      }
    ]
  },
  "enableDefaultIntentAgent": false,
  "enableDefaultWebSearch": false,
  "defaultWebSearchConfig": {
    "webSearchProvider": "linkup_normal_web_search"
  },
  "mobileAccessMode": "off",
  "chatMode": "normal",
  "dataRetentionConfig": {
    "isTemporary": true,
    "retentionPeriodDay": 1,
    "enableDataRetention": true
  },
  "agent": "text",
  "agentsConfig": {
    "ANY_ADDITIONAL_PROPERTY": {
      "capabilities": {
        "ANY_ADDITIONAL_PROPERTY": {
          "enabled": true
        }
      }
    }
  }
}

Example of a list of workflows:

{
  "workflows": [
    {
      "_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": [
        {
          "workflowId": "668e3c20aab00720ed055c3e",
          "stepType": "prompt",
          "name": "Extraction",
          "runModeDefault": "run_all_step",
          "prompt": "Identify and outline all potential risks, unusual formulations, and potential legal red flags in the document(s). Discuss the implications of these risks and suggest mitigating strategies if applicable. Generate a list of critical questions raised by the document. These questions should provoke thought, clarify uncertainties, or explore areas for further investigation. Ensure your responses are user-friendly, engaging, and easy to understand, even for individuals without a legal background.",
          "model": "anthropic-claude-v3.5-sonnet",
          "advanceOptions": {
            "temperature": 0.0,
            "topP": 1.0,
            "presencePenalty": 0.0,
            "frequencyPenalty": 0.0
          },
          "isWebSearchEnabled": true,
          "_id": "668e3c20aab00720ed055c3f",
          "createdAt": "2025-01-14T13:34:05.258280",
          "modifiedAt": "2025-01-14T13:34:05.258280"
        },
        ...
    }
  ]
}

Save the _id field as we will need it to invoke the workflow.

Invoking a workflow

With the workflow _id we get from the previous step, we should be able to invoke the workflow using the executor endpoint:

Parameters table:

Parameter	Type	Description
workflowId	string	The ID of the workflow to invoke
convoId	string	The ID of the data room to be provided to the workflow as input / context

Create Action Executor Workflow

post

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

messageIdany ofOptional

stringOptional

or

nullOptional

convoIdstringRequired

workflowIdstringRequired

attackmentIdany ofOptional

stringOptional

or

nullOptional

actionany ofOptionalDefault: continue

string · enumOptionalPossible values:

or

nullOptional

wcpOwnerIdany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/cortex/executor

HTTPcURLJavaScriptPython

POST /cortex/executor HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 119

{
  "messageId": "text",
  "convoId": "text",
  "workflowId": "text",
  "attackmentId": "text",
  "action": "continue",
  "wcpOwnerId": "text"
}

{
  "code": 1,
  "key": "text",
  "body": "text"
}

Upon triggering the endpoint, you should receive a response back with the runTaskId of the workflow run. You can then use the runTaskId to check the status of the workflow run.

{
  "code": 200,
  "key": "workflow-run-success",
  "body": {
    "convoId": "6606841895b41b9b1b6abc78",
    "runTaskId": "679212cfe5a93310cb06314d"
  }
}

Next Step

Now that your workflow is running, let's Get a Workflow Results.