Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.noxus.ai/llms.txt

Use this file to discover all available pages before exploring further.

This tutorial walks you through building a complete plugin from scratch. By the end you’ll have a plugin with custom nodes, an integration, file handling, and deployed to Noxus. We’ll build a Weather Plugin across six sections, each adding a new capability:

1. Plugin Definition

Scaffold the project, define the plugin class, validate, and run locally.

2. First Node

Create a node with inputs, outputs, and logic. Test it with curl.

3. First Integration

Define credentials and an integration for an external API.

4. Use Integration in Node

Wire the integration into your node to call a real API with credentials.

5. Working with Files

Read and create files from plugin nodes.

6. Advanced Techniques

Config UI controls, dynamic config, list handling, error handling, and deployment.

​
Prerequisites

  • Python 3.10+
  • The Noxus SDK installed: pip install noxus-sdk
  • Basic familiarity with Python, Pydantic, and async/await

​
What we’re building

A Weather Plugin that:
  • Provides a Get Weather node that fetches weather data for any city
  • Includes a Weather API integration to manage API key credentials securely
  • Has nodes for reading and creating files
  • Uses configuration UI controls so users can customize behavior in the editor
Each section builds on the previous one — start at section 1 and work through them in order, or jump to the section you need.