> For the complete documentation index, see [llms.txt](https://api.docs.blockbrain.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api.docs.blockbrain.ai/getting-started/workflows/get-a-workflow-results.md). # Get a Workflow Results ## See workflow results ### Get all previous runs To get the list of all previous workflow runs, use the `get workflow runs` endpoint: ## GET /cortex/executor/get-detail-run-tasks > Get Detail Run Tasks ```json {"openapi":"3.1.0","info":{"title":"Blockbrain Knowledge Bots","version":"0.2.6"},"security":[{"HTTPBearer":[]}],"components":{"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}},"schemas":{"RunTaskDetailedListResponse":{"properties":{"totalCount":{"type":"integer","title":"Totalcount"},"currentPage":{"type":"integer","title":"Currentpage"},"data":{"items":{"$ref":"#/components/schemas/RunTaskDetailedDTO"},"type":"array","title":"Data"}},"type":"object","required":["totalCount","currentPage","data"],"title":"RunTaskDetailedListResponse"},"RunTaskDetailedDTO":{"properties":{"_id":{"type":"string","title":"Id"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"modifiedAt":{"type":"string","format":"date-time","title":"Modifiedat"},"botId":{"type":"string","title":"Botid","default":""},"botName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Botname","default":""},"isDeletedBot":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isdeletedbot","default":false},"convoId":{"type":"string","title":"Convoid","default":""},"convoName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Convoname","default":""},"isDeletedConvo":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isdeletedconvo","default":false},"userId":{"type":"string","title":"Userid","default":""},"workflowId":{"type":"string","title":"Workflowid","default":""},"currentWorkflowStepId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currentworkflowstepid"},"status":{"$ref":"#/components/schemas/RunTaskStatus","default":"running"},"finishAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finishat","default":""},"noteId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Noteid"},"targetConvoId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Targetconvoid"},"knowledgeBases":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Knowledgebases"},"runMode":{"anyOf":[{"$ref":"#/components/schemas/WorkFlowRunMode"},{"type":"null"}],"default":"run_all_step"},"jobId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobid"},"autoAdvance":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Autoadvance"},"workflow":{"anyOf":[{"$ref":"#/components/schemas/WorkflowBasicDetailedDTO"},{"type":"null"}]}},"type":"object","required":["_id","createdAt","modifiedAt"],"title":"RunTaskDetailedDTO"},"RunTaskStatus":{"type":"string","enum":["running","success_step","failed_step","paused","success","stop","failed","retrying"],"title":"RunTaskStatus"},"WorkFlowRunMode":{"type":"string","enum":["step_by_step","run_all_step"],"title":"WorkFlowRunMode"},"WorkflowBasicDetailedDTO":{"properties":{"_id":{"type":"string","title":"Id"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"modifiedAt":{"type":"string","format":"date-time","title":"Modifiedat"},"botId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Botid"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"}},"type":"object","required":["_id","createdAt","modifiedAt","name","description"],"title":"WorkflowBasicDetailedDTO"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/cortex/executor/get-detail-run-tasks":{"get":{"tags":["cortex","cortex executor"],"summary":"Get Detail Run Tasks","operationId":"get_detail_run_tasks_cortex_executor_get_detail_run_tasks_get","parameters":[{"name":"bot_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Bot Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"workflow_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","default":20,"title":"Size"}},{"name":"sort_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"createdAt","title":"Sort By"}},{"name":"sort_order","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"default":"desc","title":"Sort Order"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunTaskDetailedListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` Example response: ```json { "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 /cortex/executor/get-workflow-by-run-task-id/{run\_task\_id} > Get Workflow By Run Task Id ```json {"openapi":"3.1.0","info":{"title":"Blockbrain Knowledge Bots","version":"0.2.6"},"security":[{"HTTPBearer":[]}],"components":{"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}},"schemas":{"WorkflowDetailedDTO":{"properties":{"_id":{"type":"string","title":"Id"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"modifiedAt":{"type":"string","format":"date-time","title":"Modifiedat"},"botId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Botid"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"isDefault":{"type":"boolean","title":"Isdefault","default":false},"runModeDefault":{"$ref":"#/components/schemas/WorkFlowRunMode","default":"run_all_step"},"isDefaultContext":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isdefaultcontext","default":false},"workflowSteps":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/WorkflowIntegrationStepDetailedDTO"},{"$ref":"#/components/schemas/WorkflowPromptStepDetailedDTO"}]},"type":"array"},{"type":"null"}],"title":"Workflowsteps","default":[]}},"type":"object","required":["_id","createdAt","modifiedAt","name","description"],"title":"WorkflowDetailedDTO"},"WorkFlowRunMode":{"type":"string","enum":["step_by_step","run_all_step"],"title":"WorkFlowRunMode"},"WorkflowIntegrationStepDetailedDTO":{"properties":{"workflowId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflowid"},"stepType":{"$ref":"#/components/schemas/WorkflowStepType","description":"Type of the step, e.g., 'prompt' or 'integration'","default":"prompt"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the step, applicable to 'prompt' steps"},"runModeDefault":{"$ref":"#/components/schemas/WorkFlowStepRunMode","default":"run_all_step"},"apiUrl":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Apiurl","description":"The endpoint URL for the integration API."},"attachPreviousStepOutput":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Attachpreviousstepoutput","description":"Attach previous step output.","default":false},"auth":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/WorkflowIntegrationStepAuthenticationBasic"},{"$ref":"#/components/schemas/WorkflowIntegrationStepAuthenticationBearer"}],"discriminator":{"propertyName":"type","mapping":{"basic":"#/components/schemas/WorkflowIntegrationStepAuthenticationBasic","bearer":"#/components/schemas/WorkflowIntegrationStepAuthenticationBearer"}}},{"type":"null"}],"title":"Auth","description":"Authentication details for the integration API."},"headers":{"items":{"$ref":"#/components/schemas/WorkflowIntegrationStepHeader"},"type":"array","title":"Headers","description":"Optional headers to include in the API request.","default":[]},"payload":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Payload","description":"Optional payload to include in the API request."},"queryParams":{"items":{"$ref":"#/components/schemas/WorkflowIntegrationStepQueryParam"},"type":"array","title":"Queryparams","description":"Optional query parameters to include in the API request.","default":[]},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"title":"Method","description":"HTTP method to use, e.g., 'GET', 'POST'.","default":"GET"},"timeout":{"type":"integer","title":"Timeout","description":"Timeout for the API request in seconds.","default":10},"retries":{"type":"integer","title":"Retries","description":"Number of retries for the API request.","default":3},"_id":{"type":"string","title":"Id"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"modifiedAt":{"type":"string","format":"date-time","title":"Modifiedat"}},"type":"object","required":["apiUrl","_id","createdAt","modifiedAt"],"title":"WorkflowIntegrationStepDetailedDTO"},"WorkflowStepType":{"type":"string","enum":["prompt","integration"],"title":"WorkflowStepType"},"WorkFlowStepRunMode":{"type":"string","enum":["step_by_step","run_all_step"],"title":"WorkFlowStepRunMode"},"WorkflowIntegrationStepAuthenticationBasic":{"properties":{"type":{"type":"string","const":"basic","title":"Type","description":"The authentication type.","default":"basic"},"username":{"type":"string","title":"Username","description":"The username for basic authentication."},"password":{"type":"string","title":"Password","description":"The password for basic authentication."}},"type":"object","required":["username","password"],"title":"WorkflowIntegrationStepAuthenticationBasic"},"WorkflowIntegrationStepAuthenticationBearer":{"properties":{"type":{"type":"string","const":"bearer","title":"Type","description":"The authentication type.","default":"bearer"},"token":{"type":"string","title":"Token","description":"The token for bearer authentication."}},"type":"object","required":["token"],"title":"WorkflowIntegrationStepAuthenticationBearer"},"WorkflowIntegrationStepHeader":{"properties":{"key":{"type":"string","title":"Key","description":"The header key."},"value":{"type":"string","title":"Value","description":"The header value."},"isActive":{"type":"boolean","title":"Isactive","description":"Whether the header should be activated.","default":true}},"type":"object","required":["key","value"],"title":"WorkflowIntegrationStepHeader"},"WorkflowIntegrationStepQueryParam":{"properties":{"key":{"type":"string","title":"Key","description":"The header key."},"value":{"type":"string","title":"Value","description":"The header value."},"isActive":{"type":"boolean","title":"Isactive","description":"Whether the header should be activated.","default":true}},"type":"object","required":["key","value"],"title":"WorkflowIntegrationStepQueryParam"},"WorkflowPromptStepDetailedDTO":{"properties":{"workflowId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflowid"},"stepType":{"$ref":"#/components/schemas/WorkflowStepType","description":"Type of the step, e.g., 'prompt' or 'integration'","default":"prompt"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the step, applicable to 'prompt' steps"},"runModeDefault":{"$ref":"#/components/schemas/WorkFlowStepRunMode","default":"run_all_step"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt","description":"Prompt for the user, applicable to 'prompt' steps"},"model":{"anyOf":[{"$ref":"#/components/schemas/AIModel"},{"type":"null"}],"description":"Applicable only to 'prompt' steps"},"advanceOptions":{"$ref":"#/components/schemas/AdvanceOptions","default":{"temperature":0.7,"topP":1,"presencePenalty":0,"frequencyPenalty":0}},"isWebSearchEnabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Iswebsearchenabled","default":false},"webSearchType":{"anyOf":[{"$ref":"#/components/schemas/WebSearchType"},{"type":"null"}],"default":"normal_web_search"},"webSearchConfig":{"anyOf":[{"$ref":"#/components/schemas/WebSearchConfig"},{"type":"null"}]},"_id":{"type":"string","title":"Id"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"modifiedAt":{"type":"string","format":"date-time","title":"Modifiedat"}},"type":"object","required":["_id","createdAt","modifiedAt"],"title":"WorkflowPromptStepDetailedDTO"},"AIModel":{"type":"string","enum":["gpt-3.5-turbo","gpt-4","gpt-4-1106-preview","gpt-4-vision","gpt-4o","gpt-4o-mini","gpt-45","gpt-5","gpt-5-mini","gpt-5-nano","gpt-5-chat","openai-o1","openai-o1-mini","openai-o3-mini","openai-o3","openai-o4-mini","openai-o3-pro","openai-gpt-4o-realtime-audio","azure-gpt-35-turbo","azure-gpt-4","azure-gpt-4-turbo","azure-gpt-4-turbo-vision","azure-gpt-4o","azure-gpt-4o-mini","azure-gpt-41","azure-gpt-41-mini","azure-gpt-41-nano","azure-gpt-5","azure-gpt-5-mini","azure-gpt-5-nano","azure-gpt-5-chat","azure-model-router","azure-openai-o1","azure-openai-o1-mini","azure-openai-o3-mini","azure-openai-o3","azure-openai-o4-mini","azure-openai-o3-pro","azure-gpt-4o-realtime-audio","azure-ai-deepseek-r1-us","anthropic-claude-v3-opus","anthropic-claude-v3-sonnet","anthropic-claude-v3-haiku","anthropic-claude-v3.5-sonnet","anthropic-claude-v3.5-sonnet-v2","anthropic-claude-v3.7-sonnet","anthropic-claude-v3.7-sonnet-thinking-mode","anthropic-claude-opus-4","anthropic-claude-sonnet-4","anthropic-claude-opus-4.1","google-gemini","google-gemini-1.0-vision","google-gemini-1.5-pro","google-gemini-1.5-flash","google-gemini-2.0-flash","google-gemini-2.0-flash-thinking-mode","google-gemini-2.0-flash-lite","google-gemini-2.5-pro","google-gemini-2.5-flash","google-gemini-2.5-flash-lite","google-vertex-gemma-2","google-vertex-mistral-large","google-vertex-mistral-nemo","google-vertex-codestral","google-anthropic-claude-v3-opus","google-anthropic-claude-v3-sonnet","google-anthropic-claude-v3-haiku","google-anthropic-claude-v3.5-sonnet","google-anthropic-claude-v3.5-sonnet-v2","google-anthropic-claude-v3.5-haiku","google-anthropic-claude-v3.7-sonnet","google-anthropic-claude-v3.7-sonnet-thinking-mode","google-anthropic-claude-opus-4","google-anthropic-claude-sonnet-4","google-anthropic-claude-opus-4.1","google-llama-405b-maas","google-llama-70b-maas","google-llama-8b-maas","google-llama-32-90b-vision-maas","google-llama-4-scout-17b-16e-maas","google-llama-4-maverick-17b-128e-maas","google-vertex-ai21-jamba-large","google-vertex-ai21-jamba-mini","deepseek-chat-v3","deepseek-reasoner","nebius-deepseek-chat-v3","nebius-deepseek-r1","xai-grok-3","xai-grok-3-mini","xai-grok-3-mini-thinking-mode","xai-grok-2-vision","xai-grok-4","mistral-medium","mistral-small","mistral-large","magistral-medium"],"title":"AIModel"},"AdvanceOptions":{"properties":{"temperature":{"type":"number","maximum":2,"minimum":0,"title":"Temperature","default":0.7},"topP":{"type":"number","maximum":1,"minimum":0,"title":"Topp","default":1},"presencePenalty":{"type":"number","maximum":2,"minimum":-2,"title":"Presencepenalty","default":0},"frequencyPenalty":{"type":"number","maximum":2,"minimum":-2,"title":"Frequencypenalty","default":0}},"type":"object","title":"AdvanceOptions"},"WebSearchType":{"type":"string","enum":["normal_web_search","pro_web_search","pro_r_web_search"],"title":"WebSearchType"},"WebSearchConfig":{"properties":{"webSearchProvider":{"$ref":"#/components/schemas/WebSearchProvider","default":"linkup_normal_web_search"},"isLinkupDeepSearch":{"type":"boolean","title":"Islinkupdeepsearch","default":false}},"type":"object","title":"WebSearchConfig"},"WebSearchProvider":{"type":"string","enum":["linkup_normal_web_search","linkup_pro_web_search","linkup_pro_r_web_search","tavily_normal_web_search","tavily_pro_web_search","tavily_pro_r_web_search","perplexity_normal_web_search","perplexity_pro_web_search"],"title":"WebSearchProvider"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/cortex/executor/get-workflow-by-run-task-id/{run_task_id}":{"get":{"tags":["cortex","cortex executor"],"summary":"Get Workflow By Run Task Id","operationId":"get_workflow_by_run_task_id_cortex_executor_get_workflow_by_run_task_id__run_task_id__get","parameters":[{"name":"run_task_id","in":"path","required":true,"schema":{"type":"string","title":"Run Task Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDetailedDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` 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: ```json { "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 /cortex/executor/get-workflow-step-output/{run\_task\_id}/{step\_id} > Get Workflow Step Output ```json {"openapi":"3.1.0","info":{"title":"Blockbrain Knowledge Bots","version":"0.2.6"},"security":[{"HTTPBearer":[]}],"components":{"securitySchemes":{"HTTPBearer":{"type":"http","scheme":"bearer"}},"schemas":{"StepOutputDetailDTO":{"properties":{"stepOutput":{"anyOf":[{"$ref":"#/components/schemas/WorkflowStepResultDTO"},{"type":"null"}]},"runTask":{"$ref":"#/components/schemas/WorkflowRunTaskDTO"}},"type":"object","title":"StepOutputDetailDTO"},"WorkflowStepResultDTO":{"properties":{"_id":{"type":"string","title":"Id"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"modifiedAt":{"type":"string","format":"date-time","title":"Modifiedat"},"botId":{"type":"string","title":"Botid","default":""},"convoId":{"type":"string","title":"Convoid","default":""},"convoName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Convoname"},"runTaskId":{"type":"string","title":"Runtaskid","default":""},"content":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}],"title":"Content"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"},"langfuseUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Langfuseurl","default":""},"messageId":{"type":"string","title":"Messageid","default":""},"selectedWorkflowId":{"type":"string","title":"Selectedworkflowid","default":""},"selectedWorkflowStepId":{"type":"string","title":"Selectedworkflowstepid","default":""},"status":{"anyOf":[{"$ref":"#/components/schemas/RunStepStatus"},{"type":"null"}],"default":"success"},"noteId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Noteid"},"model":{"anyOf":[{"$ref":"#/components/schemas/AIModel"},{"$ref":"#/components/schemas/ImageGenerationModel"},{"$ref":"#/components/schemas/VideoGenerationModel"},{"type":"null"}],"title":"Model"},"referMessageId":{"type":"string","title":"Refermessageid","default":""},"referContent":{"type":"string","title":"Refercontent","default":""},"knowledgeBases":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Knowledgebases"},"stepContext":{"anyOf":[{"$ref":"#/components/schemas/WorkflowStepContextDetailedDTO"},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"webSearchQuery":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Websearchquery"},"webRef":{"items":{"$ref":"#/components/schemas/WebSearchRef"},"type":"array","title":"Webref"},"webProRef":{"items":{"$ref":"#/components/schemas/WebSearchProRef"},"type":"array","title":"Webproref"},"isWebProR":{"type":"boolean","title":"Iswebpror","default":false},"webSearchConfig":{"anyOf":[{"$ref":"#/components/schemas/WebSearchConfig"},{"type":"null"}]},"responseMessage":{"anyOf":[{"$ref":"#/components/schemas/CortexMessage"},{"type":"null"}]},"docRef":{"anyOf":[{"items":{"$ref":"#/components/schemas/DocRefDTO"},"type":"array"},{"type":"null"}],"title":"Docref"},"uploadedFiles":{"anyOf":[{"items":{"$ref":"#/components/schemas/AttachedFiles"},"type":"array"},{"type":"null"}],"title":"Uploadedfiles"},"isCompanyGpt":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Iscompanygpt","default":false}},"type":"object","required":["_id","createdAt","modifiedAt","content"],"title":"WorkflowStepResultDTO"},"RunStepStatus":{"type":"string","enum":["waitting","running","failed","paused","success","success_step","failed_step"],"title":"RunStepStatus"},"AIModel":{"type":"string","enum":["gpt-3.5-turbo","gpt-4","gpt-4-1106-preview","gpt-4-vision","gpt-4o","gpt-4o-mini","gpt-45","gpt-5","gpt-5-mini","gpt-5-nano","gpt-5-chat","openai-o1","openai-o1-mini","openai-o3-mini","openai-o3","openai-o4-mini","openai-o3-pro","openai-gpt-4o-realtime-audio","azure-gpt-35-turbo","azure-gpt-4","azure-gpt-4-turbo","azure-gpt-4-turbo-vision","azure-gpt-4o","azure-gpt-4o-mini","azure-gpt-41","azure-gpt-41-mini","azure-gpt-41-nano","azure-gpt-5","azure-gpt-5-mini","azure-gpt-5-nano","azure-gpt-5-chat","azure-model-router","azure-openai-o1","azure-openai-o1-mini","azure-openai-o3-mini","azure-openai-o3","azure-openai-o4-mini","azure-openai-o3-pro","azure-gpt-4o-realtime-audio","azure-ai-deepseek-r1-us","anthropic-claude-v3-opus","anthropic-claude-v3-sonnet","anthropic-claude-v3-haiku","anthropic-claude-v3.5-sonnet","anthropic-claude-v3.5-sonnet-v2","anthropic-claude-v3.7-sonnet","anthropic-claude-v3.7-sonnet-thinking-mode","anthropic-claude-opus-4","anthropic-claude-sonnet-4","anthropic-claude-opus-4.1","google-gemini","google-gemini-1.0-vision","google-gemini-1.5-pro","google-gemini-1.5-flash","google-gemini-2.0-flash","google-gemini-2.0-flash-thinking-mode","google-gemini-2.0-flash-lite","google-gemini-2.5-pro","google-gemini-2.5-flash","google-gemini-2.5-flash-lite","google-vertex-gemma-2","google-vertex-mistral-large","google-vertex-mistral-nemo","google-vertex-codestral","google-anthropic-claude-v3-opus","google-anthropic-claude-v3-sonnet","google-anthropic-claude-v3-haiku","google-anthropic-claude-v3.5-sonnet","google-anthropic-claude-v3.5-sonnet-v2","google-anthropic-claude-v3.5-haiku","google-anthropic-claude-v3.7-sonnet","google-anthropic-claude-v3.7-sonnet-thinking-mode","google-anthropic-claude-opus-4","google-anthropic-claude-sonnet-4","google-anthropic-claude-opus-4.1","google-llama-405b-maas","google-llama-70b-maas","google-llama-8b-maas","google-llama-32-90b-vision-maas","google-llama-4-scout-17b-16e-maas","google-llama-4-maverick-17b-128e-maas","google-vertex-ai21-jamba-large","google-vertex-ai21-jamba-mini","deepseek-chat-v3","deepseek-reasoner","nebius-deepseek-chat-v3","nebius-deepseek-r1","xai-grok-3","xai-grok-3-mini","xai-grok-3-mini-thinking-mode","xai-grok-2-vision","xai-grok-4","mistral-medium","mistral-small","mistral-large","magistral-medium"],"title":"AIModel"},"ImageGenerationModel":{"type":"string","enum":["openai-dall-e-3","azure-dall-e-3","google-vertex-imagen","azure-gpt-image-1"],"title":"ImageGenerationModel"},"VideoGenerationModel":{"type":"string","enum":["azure-sora","vertex-ai-veo-2","vertex-ai-veo-3","vertex-ai-veo-3-fast"],"title":"VideoGenerationModel"},"WorkflowStepContextDetailedDTO":{"properties":{"workflowId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflowid","default":""},"workflowStepId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflowstepid","default":""},"contexts":{"items":{"$ref":"#/components/schemas/ContextDTO"},"type":"array","title":"Contexts","default":[]}},"type":"object","title":"WorkflowStepContextDetailedDTO"},"ContextDTO":{"properties":{"convoId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Convoid"},"convoName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Convoname"},"previousStepIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Previousstepids"},"type":{"$ref":"#/components/schemas/ContextType","default":"convo"}},"type":"object","title":"ContextDTO"},"ContextType":{"type":"string","enum":["source_message","convo","note","knowledge_base","file","previous_step"],"title":"ContextType"},"WebSearchRef":{"properties":{"query":{"type":"string","title":"Query"},"answer":{"items":{"$ref":"#/components/schemas/WebRef"},"type":"array","title":"Answer","default":[]}},"type":"object","required":["query"],"title":"WebSearchRef"},"WebRef":{"properties":{"id":{"type":"string","title":"Id"},"url":{"type":"string","title":"Url"},"content":{"type":"string","title":"Content"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"}},"type":"object","required":["id","url","content"],"title":"WebRef"},"WebSearchProRef":{"properties":{"question":{"type":"string","title":"Question"},"search_queries":{"items":{"$ref":"#/components/schemas/WebSearchRef"},"type":"array","title":"Search Queries","default":[]}},"type":"object","required":["question"],"title":"WebSearchProRef"},"WebSearchConfig":{"properties":{"webSearchProvider":{"$ref":"#/components/schemas/WebSearchProvider","default":"linkup_normal_web_search"},"isLinkupDeepSearch":{"type":"boolean","title":"Islinkupdeepsearch","default":false}},"type":"object","title":"WebSearchConfig"},"WebSearchProvider":{"type":"string","enum":["linkup_normal_web_search","linkup_pro_web_search","linkup_pro_r_web_search","tavily_normal_web_search","tavily_pro_web_search","tavily_pro_r_web_search","perplexity_normal_web_search","perplexity_pro_web_search"],"title":"WebSearchProvider"},"CortexMessage":{"properties":{"_id":{"type":"string","title":"Id"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"modifiedAt":{"type":"string","format":"date-time","title":"Modifiedat"},"botId":{"type":"string","title":"Botid"},"userId":{"type":"string","title":"Userid"},"convoId":{"type":"string","title":"Convoid"},"content":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}],"title":"Content"},"role":{"type":"string","title":"Role"},"model":{"anyOf":[{"$ref":"#/components/schemas/AIModel"},{"$ref":"#/components/schemas/ImageGenerationModel"},{"$ref":"#/components/schemas/VideoGenerationModel"},{"type":"null"}],"title":"Model"},"messageType":{"$ref":"#/components/schemas/api__nexus__conversation__constants__MessageType","default":"assistant-greeting"},"status":{"$ref":"#/components/schemas/MessageStatus","default":"activate"},"langfuseUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Langfuseurl","default":""},"currentContent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currentcontent"},"uploadedFiles":{"items":{"$ref":"#/components/schemas/AttachedFiles"},"type":"array","title":"Uploadedfiles","default":[]},"isSaved":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Issaved","default":false},"noteId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Noteid"},"insightsGraphType":{"anyOf":[{"$ref":"#/components/schemas/InsightsGraphType"},{"type":"null"}]},"doc_ref":{"anyOf":[{"items":{"$ref":"#/components/schemas/DocRef"},"type":"array"},{"type":"null"}],"title":"Doc Ref"},"webSearchQuery":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Websearchquery"},"webRef":{"items":{"$ref":"#/components/schemas/WebSearchRef"},"type":"array","title":"Webref"},"webProRef":{"items":{"$ref":"#/components/schemas/WebSearchProRef"},"type":"array","title":"Webproref"},"isWebProR":{"type":"boolean","title":"Iswebpror","default":false},"webSearchConfig":{"anyOf":[{"$ref":"#/components/schemas/WebSearchConfig"},{"type":"null"}]},"standaloneQuestion":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Standalonequestion"},"relatedChunkIds":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Relatedchunkids","default":[]},"targetText":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Targettext"},"targetMessageId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Targetmessageid"},"targetFullContent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Targetfullcontent"},"messageReplies":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Messagereplies","default":[]},"isUnliked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isunliked"},"feedbackAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Feedbackat"},"feedbackContent":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Feedbackcontent"},"selectedWorkflowId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Selectedworkflowid","default":""},"workflow":{"anyOf":[{"$ref":"#/components/schemas/SelectedWorkflow"},{"type":"null"}]},"selectedAgentTask":{"anyOf":[{"$ref":"#/components/schemas/AgentTaskDetailedDTO"},{"type":"null"}]},"selectedStrategy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Selectedstrategy","default":""},"selectedAction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Selectedaction","default":""},"strategies":{"items":{"$ref":"#/components/schemas/CortexStrategyResponse"},"type":"array","title":"Strategies","default":[]},"targetSelectedStrategy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Targetselectedstrategy","default":""},"targetSelectedAction":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Targetselectedaction","default":""},"targetAgentTask":{"anyOf":[{"$ref":"#/components/schemas/AgentTaskDetailedDTO"},{"type":"null"}]},"promptMessageId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Promptmessageid","default":""},"messageQueryId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Messagequeryid"},"mediaUrls":{"anyOf":[{"items":{"$ref":"#/components/schemas/GeneratedMedia"},"type":"array"},{"type":"null"}],"title":"Mediaurls"}},"type":"object","required":["botId","userId","convoId","content","role"],"title":"CortexMessage"},"api__nexus__conversation__constants__MessageType":{"type":"string","enum":["assistant-greeting","assistant-response","user-idea","user-question","user-select-agent","greeting","conversation","user-direct-agent"],"title":"MessageType"},"MessageStatus":{"type":"string","enum":["activate","deactivate","deleted"],"title":"MessageStatus"},"AttachedFiles":{"properties":{"_id":{"type":"string","title":"Id"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"modifiedAt":{"type":"string","format":"date-time","title":"Modifiedat"},"name":{"type":"string","title":"Name"},"key":{"type":"string","title":"Key"},"tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Tokens","default":0},"enabled":{"type":"boolean","title":"Enabled","default":true},"errorMessage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Errormessage"},"status":{"$ref":"#/components/schemas/AttachmentStatus","default":"SUCCESS"},"calculatedStatus":{"$ref":"#/components/schemas/CalculatedStatus","default":"SUCCESS"},"convoId":{"type":"string","title":"Convoid","default":""},"fileType":{"anyOf":[{"$ref":"#/components/schemas/AttachmentFileType"},{"type":"null"}],"default":"TEXT"},"fileSize":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"title":"Filesize","default":0},"imageDescription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Imagedescription","default":""},"imageWidth":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Imagewidth"},"imageHeight":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Imageheight"},"userId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Userid"},"imageResizeKey":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Imageresizekey"},"imageThumbKey":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Imagethumbkey"},"zipAttachmentId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Zipattachmentid"}},"type":"object","required":["name","key"],"title":"AttachedFiles"},"AttachmentStatus":{"type":"string","enum":["IN_PROGRESS","SUCCESS","SUCCESS_TRUNCATED","FAILED"],"title":"AttachmentStatus"},"CalculatedStatus":{"type":"string","enum":["IN_PROGRESS","SUCCESS","FAILED"],"title":"CalculatedStatus"},"AttachmentFileType":{"type":"string","enum":["TEXT","IMAGE","AUDIO","VIDEO","OTHER"],"title":"AttachmentFileType"},"InsightsGraphType":{"type":"string","enum":["STATUS_QUO","VISION","LEGACY"],"title":"InsightsGraphType"},"DocRef":{"properties":{"doc_id":{"type":"string","title":"Doc Id"},"doc_name":{"type":"string","title":"Doc Name"},"text_id":{"items":{"anyOf":[{"$ref":"#/components/schemas/Chunk"},{"type":"string"}]},"type":"array","title":"Text Id","default":[]},"originalUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Originalurl"},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score","default":0},"doc_type":{"anyOf":[{"$ref":"#/components/schemas/RefDocType"},{"type":"null"}],"default":"vector-db"},"isTemplate":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Istemplate","default":false},"imageResizeKey":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Imageresizekey"},"imageThumbKey":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Imagethumbkey"}},"type":"object","required":["doc_id","doc_name"],"title":"DocRef"},"Chunk":{"properties":{"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"},"text_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text Id"},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score","default":0},"isRelatedChunk":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isrelatedchunk","default":false},"doc_type":{"anyOf":[{"$ref":"#/components/schemas/RefDocType"},{"type":"null"}],"default":"vector-db"}},"type":"object","title":"Chunk"},"RefDocType":{"type":"string","enum":["vector-db","prompt-injection","full-text-db","hybrid-db"],"title":"RefDocType"},"SelectedWorkflow":{"properties":{"runTaskId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Runtaskid","default":""},"workflowId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflowid","default":""},"workflowName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflowname","default":""},"stepId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stepid","default":""},"stepName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stepname","default":""}},"type":"object","title":"SelectedWorkflow"},"AgentTaskDetailedDTO":{"properties":{"_id":{"type":"string","title":"Id"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"modifiedAt":{"type":"string","format":"date-time","title":"Modifiedat"},"category_id":{"type":"string","title":"Category Id"},"name":{"type":"string","title":"Name"},"type":{"$ref":"#/components/schemas/AgentTaskType","default":"custom"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"category":{"anyOf":[{"$ref":"#/components/schemas/AgentCategoryDetailedDTO"},{"type":"null"}]},"isFavorite":{"type":"boolean","title":"Isfavorite","default":false},"isSelected":{"type":"boolean","title":"Isselected","default":false},"isActive":{"type":"boolean","title":"Isactive","default":false},"categoryName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Categoryname"}},"type":"object","required":["_id","createdAt","modifiedAt","category_id","name"],"title":"AgentTaskDetailedDTO"},"AgentTaskType":{"type":"string","enum":["custom","template","tenant"],"title":"AgentTaskType"},"AgentCategoryDetailedDTO":{"properties":{"_id":{"type":"string","title":"Id"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"modifiedAt":{"type":"string","format":"date-time","title":"Modifiedat"},"icon":{"type":"string","title":"Icon"},"name":{"type":"string","title":"Name"},"owner":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Owner"},"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count"},"isPublic":{"type":"boolean","title":"Ispublic","default":false},"isTemplate":{"type":"boolean","title":"Istemplate","default":false}},"type":"object","required":["_id","createdAt","modifiedAt","icon","name"],"title":"AgentCategoryDetailedDTO"},"CortexStrategyResponse":{"properties":{"name":{"type":"string","title":"Name"},"slug":{"type":"string","title":"Slug","default":""},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","default":""},"icon":{"type":"string","title":"Icon","description":"icon key from heroicons","default":""},"actions":{"items":{"$ref":"#/components/schemas/CortextActionResponse"},"type":"array","title":"Actions"},"scopes":{"items":{"$ref":"#/components/schemas/CortexStrategyScope"},"type":"array","title":"Scopes","default":["scope-bot","scope-user"]},"isDefault":{"type":"boolean","title":"Isdefault","default":true}},"type":"object","required":["name","actions"],"title":"CortexStrategyResponse"},"CortextActionResponse":{"properties":{"name":{"type":"string","title":"Name"},"slug":{"type":"string","title":"Slug","default":""},"prompt":{"type":"string","title":"Prompt","default":""},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","default":""},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon","description":"icon key from heroicons","default":""},"isDefault":{"type":"boolean","title":"Isdefault","default":true}},"type":"object","required":["name"],"title":"CortextActionResponse"},"CortexStrategyScope":{"type":"string","enum":["scope-user","scope-bot"],"title":"CortexStrategyScope"},"GeneratedMedia":{"properties":{"contentType":{"type":"string","title":"Contenttype"},"url":{"type":"string","title":"Url","description":"The URL of the generated media file."}},"type":"object","required":["contentType","url"],"title":"GeneratedMedia"},"DocRefDTO":{"properties":{"doc_id":{"type":"string","title":"Doc Id"},"doc_name":{"type":"string","title":"Doc Name"},"text_id":{"items":{"anyOf":[{"$ref":"#/components/schemas/Chunk"},{"type":"null"}]},"type":"array","title":"Text Id","default":[]},"isDownloadable":{"type":"boolean","title":"Isdownloadable","default":false},"originalUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Originalurl"},"thumbUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Thumburl"},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score","default":0},"doc_type":{"$ref":"#/components/schemas/RefDocType","default":"vector-db"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"status":{"anyOf":[{"$ref":"#/components/schemas/AttachmentStatus"},{"type":"null"}],"default":"SUCCESS"},"kb_filetype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kb Filetype"},"docExist":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Docexist","default":true},"havePermission":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Havepermission","default":true},"breadcrumb":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Breadcrumb"},"isExtractedZipFileSharepoint":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isextractedzipfilesharepoint","default":false}},"type":"object","required":["doc_id","doc_name"],"title":"DocRefDTO"},"WorkflowRunTaskDTO":{"properties":{"workflowId":{"type":"string","title":"Workflowid","default":""},"runMode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Runmode"},"currentWorkflowStepId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currentworkflowstepid"},"status":{"$ref":"#/components/schemas/RunTaskStatus","default":"running"},"finishAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Finishat"},"noteId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Noteid"},"targetConvoId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Targetconvoid"},"knowledgeBases":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Knowledgebases"},"workflow":{"anyOf":[{"$ref":"#/components/schemas/WorkflowDetailedDTO"},{"type":"null"}]},"jobId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Jobid"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"autoAdvance":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Autoadvance"}},"type":"object","title":"WorkflowRunTaskDTO"},"RunTaskStatus":{"type":"string","enum":["running","success_step","failed_step","paused","success","stop","failed","retrying"],"title":"RunTaskStatus"},"WorkflowDetailedDTO":{"properties":{"_id":{"type":"string","title":"Id"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"modifiedAt":{"type":"string","format":"date-time","title":"Modifiedat"},"botId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Botid"},"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"isDefault":{"type":"boolean","title":"Isdefault","default":false},"runModeDefault":{"$ref":"#/components/schemas/WorkFlowRunMode","default":"run_all_step"},"isDefaultContext":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Isdefaultcontext","default":false},"workflowSteps":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/WorkflowIntegrationStepDetailedDTO"},{"$ref":"#/components/schemas/WorkflowPromptStepDetailedDTO"}]},"type":"array"},{"type":"null"}],"title":"Workflowsteps","default":[]}},"type":"object","required":["_id","createdAt","modifiedAt","name","description"],"title":"WorkflowDetailedDTO"},"WorkFlowRunMode":{"type":"string","enum":["step_by_step","run_all_step"],"title":"WorkFlowRunMode"},"WorkflowIntegrationStepDetailedDTO":{"properties":{"workflowId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflowid"},"stepType":{"$ref":"#/components/schemas/WorkflowStepType","description":"Type of the step, e.g., 'prompt' or 'integration'","default":"prompt"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the step, applicable to 'prompt' steps"},"runModeDefault":{"$ref":"#/components/schemas/WorkFlowStepRunMode","default":"run_all_step"},"apiUrl":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Apiurl","description":"The endpoint URL for the integration API."},"attachPreviousStepOutput":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Attachpreviousstepoutput","description":"Attach previous step output.","default":false},"auth":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/WorkflowIntegrationStepAuthenticationBasic"},{"$ref":"#/components/schemas/WorkflowIntegrationStepAuthenticationBearer"}],"discriminator":{"propertyName":"type","mapping":{"basic":"#/components/schemas/WorkflowIntegrationStepAuthenticationBasic","bearer":"#/components/schemas/WorkflowIntegrationStepAuthenticationBearer"}}},{"type":"null"}],"title":"Auth","description":"Authentication details for the integration API."},"headers":{"items":{"$ref":"#/components/schemas/WorkflowIntegrationStepHeader"},"type":"array","title":"Headers","description":"Optional headers to include in the API request.","default":[]},"payload":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Payload","description":"Optional payload to include in the API request."},"queryParams":{"items":{"$ref":"#/components/schemas/WorkflowIntegrationStepQueryParam"},"type":"array","title":"Queryparams","description":"Optional query parameters to include in the API request.","default":[]},"method":{"type":"string","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS","HEAD"],"title":"Method","description":"HTTP method to use, e.g., 'GET', 'POST'.","default":"GET"},"timeout":{"type":"integer","title":"Timeout","description":"Timeout for the API request in seconds.","default":10},"retries":{"type":"integer","title":"Retries","description":"Number of retries for the API request.","default":3},"_id":{"type":"string","title":"Id"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"modifiedAt":{"type":"string","format":"date-time","title":"Modifiedat"}},"type":"object","required":["apiUrl","_id","createdAt","modifiedAt"],"title":"WorkflowIntegrationStepDetailedDTO"},"WorkflowStepType":{"type":"string","enum":["prompt","integration"],"title":"WorkflowStepType"},"WorkFlowStepRunMode":{"type":"string","enum":["step_by_step","run_all_step"],"title":"WorkFlowStepRunMode"},"WorkflowIntegrationStepAuthenticationBasic":{"properties":{"type":{"type":"string","const":"basic","title":"Type","description":"The authentication type.","default":"basic"},"username":{"type":"string","title":"Username","description":"The username for basic authentication."},"password":{"type":"string","title":"Password","description":"The password for basic authentication."}},"type":"object","required":["username","password"],"title":"WorkflowIntegrationStepAuthenticationBasic"},"WorkflowIntegrationStepAuthenticationBearer":{"properties":{"type":{"type":"string","const":"bearer","title":"Type","description":"The authentication type.","default":"bearer"},"token":{"type":"string","title":"Token","description":"The token for bearer authentication."}},"type":"object","required":["token"],"title":"WorkflowIntegrationStepAuthenticationBearer"},"WorkflowIntegrationStepHeader":{"properties":{"key":{"type":"string","title":"Key","description":"The header key."},"value":{"type":"string","title":"Value","description":"The header value."},"isActive":{"type":"boolean","title":"Isactive","description":"Whether the header should be activated.","default":true}},"type":"object","required":["key","value"],"title":"WorkflowIntegrationStepHeader"},"WorkflowIntegrationStepQueryParam":{"properties":{"key":{"type":"string","title":"Key","description":"The header key."},"value":{"type":"string","title":"Value","description":"The header value."},"isActive":{"type":"boolean","title":"Isactive","description":"Whether the header should be activated.","default":true}},"type":"object","required":["key","value"],"title":"WorkflowIntegrationStepQueryParam"},"WorkflowPromptStepDetailedDTO":{"properties":{"workflowId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflowid"},"stepType":{"$ref":"#/components/schemas/WorkflowStepType","description":"Type of the step, e.g., 'prompt' or 'integration'","default":"prompt"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"Name of the step, applicable to 'prompt' steps"},"runModeDefault":{"$ref":"#/components/schemas/WorkFlowStepRunMode","default":"run_all_step"},"prompt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prompt","description":"Prompt for the user, applicable to 'prompt' steps"},"model":{"anyOf":[{"$ref":"#/components/schemas/AIModel"},{"type":"null"}],"description":"Applicable only to 'prompt' steps"},"advanceOptions":{"$ref":"#/components/schemas/AdvanceOptions","default":{"temperature":0.7,"topP":1,"presencePenalty":0,"frequencyPenalty":0}},"isWebSearchEnabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Iswebsearchenabled","default":false},"webSearchType":{"anyOf":[{"$ref":"#/components/schemas/WebSearchType"},{"type":"null"}],"default":"normal_web_search"},"webSearchConfig":{"anyOf":[{"$ref":"#/components/schemas/WebSearchConfig"},{"type":"null"}]},"_id":{"type":"string","title":"Id"},"createdAt":{"type":"string","format":"date-time","title":"Createdat"},"modifiedAt":{"type":"string","format":"date-time","title":"Modifiedat"}},"type":"object","required":["_id","createdAt","modifiedAt"],"title":"WorkflowPromptStepDetailedDTO"},"AdvanceOptions":{"properties":{"temperature":{"type":"number","maximum":2,"minimum":0,"title":"Temperature","default":0.7},"topP":{"type":"number","maximum":1,"minimum":0,"title":"Topp","default":1},"presencePenalty":{"type":"number","maximum":2,"minimum":-2,"title":"Presencepenalty","default":0},"frequencyPenalty":{"type":"number","maximum":2,"minimum":-2,"title":"Frequencypenalty","default":0}},"type":"object","title":"AdvanceOptions"},"WebSearchType":{"type":"string","enum":["normal_web_search","pro_web_search","pro_r_web_search"],"title":"WebSearchType"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/cortex/executor/get-workflow-step-output/{run_task_id}/{step_id}":{"get":{"tags":["cortex","cortex executor"],"summary":"Get Workflow Step Output","operationId":"get_workflow_step_output_cortex_executor_get_workflow_step_output__run_task_id___step_id__get","parameters":[{"name":"run_task_id","in":"path","required":true,"schema":{"type":"string","title":"Run Task Id"}},{"name":"step_id","in":"path","required":true,"schema":{"type":"string","title":"Step Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StepOutputDetailDTO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` Example of a step response: ```json { "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](/getting-started/workflows/save-workflow-results.md). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://api.docs.blockbrain.ai/getting-started/workflows/get-a-workflow-results.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.