API Reference

Node.js SDK

Authorization

Cortex

Workflows

Workflow Builder

Dashboard

Book a demo

Create App Variable

Detailed information about a variable in your app

A platform that uses AI to automate financial operations.

Introduction

Understand general concepts, response codes, and authentication strategies.

Learn how to paginate and filter responses from the Cortex API.

Pagination and Filtering

Introduction to the Cortex Workflow Builder.

Input fields let users provide data that flows through workflow steps.

Overview

A comprehensive guide to understanding and implementing steps in a workflow

Learn how to access input data in steps and use the output of steps in subsequent steps.

Learn how to access and work with input data in steps.

Input Data Access

How to troubleshoot common issues when accessing data in steps.

Troubleshooting

A comprehensive guide to structuring workflow outputs, including API responses, UI displays, metrics. Learn how to format and customize outputs using markdown, structured displays, diagrams and metric blocks.

Output

Process a list of items by executing the same step repeatedly, handling each element one at a time in sequence.

Loop

Control workflow execution by defining conditions that determine whether steps should run or be skipped.

Conditional

Create conditional logic to route data down different paths

Branching

Learn about the built-in utility functions available in code steps for validation, parsing, file handling, and formatting

Utility Functions

Learn how to deploy workflows, manage versions, rollback changes, and compare different versions of your workflows.

Deploy

The SDK allows you to interact with the Cortex API from your Node.js applications

Get a list of all collections of your app.

Get Collections

Create a Collection

Fetch detailed information about a specific collection.

Get a Collection

Delete a Collection

Update a Collection

Retrieve a list of records of a specific collection.

Get Records

Create a new record in the specified collection.

Create a Record

Get a Record

Delete a Record

Update a Record

Retrieve the current status of a specific record.

Get Record Status

Execute the rules associated with a specific record and get the report.

Run a Record

Cancel the ongoing execution of a record.

Cancel a Record Run

Update the rules associated with a specific record.

Update Record Rules

Reset Record

Generate and download a PDF report of a specific record.

Download Record Report

Retrieve a list of discoverable workflows for a specific app.

Discover Workflows

Retrieve a specific discoverable workflow by its ID.

Get Discoverable Workflow

Retrieve a specific version of a discoverable workflow by ID or version number.

Get Discoverable Workflow Version

Run Discoverable Workflow

Cancel a workflow run that is currently running.

Cancel a Discoverable Workflow Run

Retrieve a list of workflows for a specific app.

Get Workflows

Get a Workflow

Retrieve a list of runs for a specific workflow.

Get Workflow Runs

Run a Workflow

Replay a Workflow Run

Retrieve details of a specific workflow run.

Get a Workflow Run

Cancel a Workflow Run

Retrieve a list of workflow versions for a specific workflow.

Get Workflow Versions

Retrieve a specific workflow version by ID or version number.

Get a Workflow Version

Retrieve a list of workflow test expectations for a specific workflow.

Get Tests Expectations

Create a new workflow test expectation for a specific workflow.

Create a Test Expectation

Retrieve a specific workflow test expectation by its ID.

Get Test Expectation

Delete a specific workflow test expectation by its ID.

Delete Test Expectation

Update a specific workflow test expectation by its ID.

Update Test Expectation

Retrieve a list of workflow tests for a specific workflow.

Get Tests

Create a new workflow test for a specific workflow.

Create a Test

Get Tests Stats

Retrieve a specific workflow test by its ID.

Get Test

Delete a specific workflow test by its ID.

Delete Test

Update a specific workflow test by its ID.

Update Test

Run all workflow tests for a specific workflow.

Run Tests

Cancel all running workflow tests for a specific workflow.

Cancel Tests

Cancel a running workflow test by its ID.

Cancel Test

Run Test

Get App Variables

Update App Variables

Delete App Variable

Rename App Variable

Retrieve a list of files for a specific app.

List Files

Create File

Get File

Delete File

Cancel the upload processing of a specific file.

Cancel File Upload

Retrieve a list of webhooks for a specific app.

Get Webhooks

Create a Webhook

Delete an existing webhook for a specific app.

Delete a Webhook

Update an existing webhook for a specific app.

API Reference

Collections

Records

Workflows

Tests

Variables

Files

Webhooks

Create App Variable

Path Parameters

Body

Response