Create a run for a specific workflow synchronously

Create Sync Run

RunStatus

Location

Message

Error Type

ValidationError

CreateRunRequest

APIKeyHeader

RunOutput

SimplifiedRun

HTTPValidationError

Noxus Documentation

[Noxus](www.getNoxus.io) is a no-code platform that enables you to automate workflows and build AI tools effortlessly. Enhance your workflows by integrating a variety of powerful tools.

Introduction

Start using AI to automate your life in just 5 minutes

Workflow Builder

Your First Tutorial

AI Operations

Overview

Clear and Concise Language

Examples to Guide the AI

Step-by-Step Reasoning

Assign a Role to AI

Select the right model

Download File

Reads a document format input and extracts its textual content.

File to Text

Make API request

This module enables you to conduct web searches on demand

List Website Entries

Read Webpage

Run Code

Create a text document containing the specified content.

Text to File

Use Search Engine

Combine multiple text inputs in one text output.

Combine Text

Use AI to extract fields from a text and turn them into outputs

Extract Fields

Filter values base on a specific condition or ask AI to filter it for you.

Condition

Filter List Values

Transform a list into a single value separated by a paragraph or a selected character.

List to Single Value

Single Value to List

Use this node after a conditional node to allow you to merge different execution paths

Join paths

Generate text using any of the state-of-the-art AI models

Generate Text

Searches the web with a goal and compiles a report

Web Research

Summarizer

Extract relevant insights about an organization and its leadership

Enrich Company

Create images using any state-of-the-art image generation AI models.

Generate Image

Analyzes images and answers questions using a Vision-capable Language Model model.

Interpret Image

Enables content translation across more than 30 languages.

Translate Text

Form

Generate or transform images using source images and advanced techniques such as style transfer or conditional generation.

Transform Image

Scorer

Quickly extract answers from processed knowledge

Knowledge Base QA

Document QA

Categorizer

Smart Route

Locate files within your Knowledge base or your cloud provider

Find Documents

Enter a company domain to extract a company summary or raw data

Generate Fields

You can access this page in settings to link all your accounts.

Integrations Page

This trigger allows users to start a workflow from Slack

Slack

This trigger allows users to start a workflow from a given email received on Gmail.

Gmail

This trigger allows users to start a workflow at a given time of the day, month, and week.

Schedule

Get Workflow

Get Workflows

Create a run for a specific workflow asynchronously

Create Async Run

Get a paginated list of runs for a workflow

Get Runs

Get Paginated  Runs

Get Run

Get Run by ID

Get Run Data by ID

Search Runs

Get Knowledge Base

Add Knowledge Base

Get all knowledge bases belonging to a user

Get Knowledge Bases

Delete Knowledge Base

Update Knowledge Base

Add Knowledge Base Document

Get Knowledge Base Document

Get Knowledge Base Documents

Update Knowledge Base Document

Delete Knowledge Base Document

Upload local documents to a knowledge base

Upload Train Knowledge Base

Train a knowledge base from a generic source

Generic Train Knowledge Base

Retry reingesting all documents with errors for a knowledge base

Retry Reingesting all Documents with Errors

Get all running jobs for a knowledge base

Get Knowledge Base Running Jobs

List Conversations

Create Conversation

Get Conversation

Delete Conversation

Add Message

Refresh Message

Add Agent

Update Agent

Duplicate Agent

Get Agents

Get Agent

Delete Agent

Restore Agent

Plugins are a way to extend the platform.

Plugins

The Noxus Configuration Language (NCL) is a powerful system for building dynamic, interactive configuration interfaces from static definitions. It provides a comprehensive set of components that can be combined to create intuitive forms, preference panels, and configuration screens throughout the Noxus platform.

Noxus Configuration Language

Node plugins let you create custom workflow components that process data, integrate with external services, and extend the platform's capabilities.

Node Plugins

Trigger plugins allow you to create custom event-based workflow triggers that respond to external events or scheduled intervals.

Trigger Plugins

Knowledge Base plugins allow you to create custom data source types for importing and processing information from external systems into your knowledge base.

KB Plugins

Plugins and integrations enable secure connections to external services and APIs, allowing users to authenticate and interact with third-party platforms.

Plugins & Integrations

Knowledge Bases

AI-powered co-workers that help users accomplish tasks through natural language

Co-worker

Text to Document

Document to Text

Extract Information

Enables content translatation across more than 30 languages.

Fill Form

Searches the web with a goal and compiles a report.

Linked Accounts

Airtable - Read Records

Writes values across any fields of Airtable bases

Airtable - Write Records

Given a specific time frame, retrieves existing events from Calendly

Calendly - Read Events

Enter a GitHub URL to extract a profile summary or raw data

Github - Read Profile

This module allows you to create and send an email directly from your Gmail account

Gmail - Send Email

This module allows you to read emails directly from your Gmail account

Gmail - Read Emails

Peeks into your Google Spreadsheets and grabs the data you need for analysis or reports.

Google Sheets - Read from Columns

Write values across any columns of your Google Sheets.

Google Sheets - Write in Columns

Grabs any documents you choose in Google Drive, ready for you to use.

Google Drive - Read Files

Saves files back into your Google Drive, wherever you want them to go.

Google Drive - Save to Folder

Read and return the text content from a Google Docs file.

Google Docs - Read Document

Google Docs - Write to Document

Given a specific time frame, retrieves existing events from Google Calendar

Google Calendar - Read Events

Create an event on Google Calendar from a received input

Google Calendar - Create Event

Enter an Instagram handle to extract a profile summary and its recent Posts

Instagram - Read Profile

Enter an Instagram Post URL to extract its comments

Instagram - Read Comments

Enter a Linkedin URL to extract a profile summary or raw data

Linkedin - Read Profile

Linkedin - Company Search

Read and return the text content from a Notion Page.

Notion - Read Page

Notion - Write Page

Read data directly from a Notion Database.

Notion - Read Database

Write data directly to a Notion Database.

Notion - Write Database

Slack - Read Messages

Slack - Write Messages

Automatically sends messages or news to a Telegram chat or group you choose, keeping everyone updated.

Telegram Writer

Typeform - Read Form Results

Enter a Youtube channel URL to extract a concise summary, detailed raw data of the channel

Youtube - Read Channel

Youtube - Transcribe Video

Get a list of runs for a specific workflow

Create Knowledge Base

Add Document

Get a specific document from a knowledge base

Get a paginated list of documents from a knowledge base

API Reference

Workflows

Runs

Knowledge Bases

Conversations

Agents (Co-workers)

Create Sync Run

Authorizations

Path Parameters

Query Parameters

Body

Response