DocumentationGetting StartedQuickstart

Quickstart

Build your first agent in 5 minutes.

Install

pip install ainalyn-sdk

Create an Agent

Create my_agent.py:

from ainalyn import AgentBuilder, WorkflowBuilder, NodeBuilder, PromptBuilder
from ainalyn.api import validate, export_yaml
 
# Define a prompt
greeting_prompt = (
    PromptBuilder("greeting-prompt")
    .description("Generates a personalized greeting")
    .template("Generate a personalized greeting for {{user_name}}")
    .variables("user_name")
    .build()
)
 
# Define the agent
agent = (
    AgentBuilder("greeting-agent")
    .description("Generates personalized greetings")
    .version("1.0.0")
    .add_prompt(greeting_prompt)
    .add_workflow(
        WorkflowBuilder("greet-user")
        .description("Main greeting workflow")
        .add_node(
            NodeBuilder("generate-greeting")
            .description("Generate a personalized greeting")
            .uses_prompt("greeting-prompt")
            .outputs("greeting")
            .build()
        )
        .entry_node("generate-greeting")
        .build()
    )
    .build()
)
 
# Validate
validate(agent)
print("Valid!")
 
# Export to YAML
yaml_output = export_yaml(agent)
print(yaml_output)

Run

python my_agent.py

Output:

Valid!
# Ainalyn Agent Definition
# This file is a description submitted to Platform Core for review.
# It does NOT execute by itself. Execution is handled by Platform Core.
#
# Local compilation does NOT equal platform execution.

name: greeting-agent
version: 1.0.0
description: Generates personalized greetings
workflows:
- name: greet-user
  description: Main greeting workflow
  entry_node: generate-greeting
  nodes:
  - name: generate-greeting
    description: Generate a personalized greeting
    type: prompt
    reference: greeting-prompt
    outputs:
    - greeting
prompts:
- name: greeting-prompt
  description: Generates a personalized greeting
  template: Generate a personalized greeting for {{user_name}}
  variables:
  - user_name

What’s Happening

  1. PromptBuilder creates a prompt template
  2. AgentBuilder creates an agent
  3. WorkflowBuilder adds a workflow with entry_node
  4. NodeBuilder adds a task node that uses the prompt
  5. validate() checks the definition
  6. export_yaml() converts to YAML

Next Steps

Using the CLI

You can also use the command line:

# Validate
ainalyn validate my_agent.py
 
# Compile to YAML
ainalyn compile my_agent.py -o output.yaml

Common Patterns

Multiple nodes with flow:

workflow = (
    WorkflowBuilder("process")
    .description("Sequential processing workflow")
    .add_node(
        NodeBuilder("step1")
        .description("First step")
        .uses_prompt("step1-prompt")
        .next_nodes("step2")
        .build()
    )
    .add_node(
        NodeBuilder("step2")
        .description("Second step")
        .uses_prompt("step2-prompt")
        .build()
    )
    .entry_node("step1")
    .build()
)

Multiple workflows:

agent = (
    AgentBuilder("my-agent")
    .version("1.0.0")
    .add_workflow(workflow1)
    .add_workflow(workflow2)
    .build()
)

Need Help?