API

API

Welcome to the NudgeLang API Reference documentation. This section provides comprehensive documentation for all aspects of the NudgeLang API.

Available Documentation

Manifest Schema

The manifest schema defines the core structure and configuration of autonomous agents in NudgeLang. Learn about the basic structure, state definitions, tool configurations, and model definitions that form the foundation of any NudgeLang agent.

State Types

Explore the various state types available in NudgeLang, including core states like Initial, LLM, Tool, and Output states, as well as advanced states like Parallel, Choice, Wait, and Map states. Each state type serves a specific purpose in building autonomous agents.

Tool Definitions

Learn how to define and use tools in NudgeLang. This section covers built-in tool types (HTTP, Database, File, Email) and custom tool implementations, along with their configuration options and best practices.

MCP Integration

Discover how to integrate NudgeLang with the Model Control Protocol (MCP) for advanced model management and control capabilities. This includes configuration, model deployment, scaling, and monitoring features.

Getting Started

To get started with the NudgeLang API:

  1. Begin with the Manifest Schema to understand the basic structure
  2. Explore State Types to learn about different ways to build your agent’s logic
  3. Check out Tool Definitions to add external capabilities to your agent
  4. Consider MCP Integration if you need advanced model management features

Each section includes detailed examples, configuration options, and best practices to help you build effective autonomous agents with NudgeLang.

Last updated on