Quick Start

Installation

TypeScript

pnpm add minions-sdk

Python

pip install minions-sdk

Create Your First Agent

TypeScript

import { TypeRegistry, createMinion } from 'minions-sdk';

const registry = new TypeRegistry();
const agentType = registry.getBySlug('agent')!;

const { minion, validation } = createMinion({
  title: 'Research Assistant',
  fields: {
    role: 'researcher',
    model: 'gpt-4',
    systemPrompt: 'You are a research assistant.',
    tools: ['web-search', 'summarize'],
  },
}, agentType);

console.log(validation.valid); // true
console.log(minion.id);        // generated UUID

Python

from minions import TypeRegistry, create_minion

registry = TypeRegistry()
agent_type = registry.get_by_slug("agent")

minion, validation = create_minion(
    {
        "title": "Research Assistant",
        "fields": {
            "role": "researcher",
            "model": "gpt-4",
            "systemPrompt": "You are a research assistant.",
            "tools": ["web-search", "summarize"],
        },
    },
    agent_type,
)

print(validation.valid)  # True
print(minion.id)         # generated UUID

Link Minions Together

TypeScript

import { RelationGraph } from 'minions-sdk';

const graph = new RelationGraph();

graph.add({
  sourceId: agent.id,
  targetId: skillMinion.id,
  type: 'parent_of',
});

const children = graph.getChildren(agent.id);
const tree = graph.getTree(agent.id);

Python

from minions import RelationGraph

graph = RelationGraph()

graph.add({
    "source_id": agent.id,
    "target_id": skill_minion.id,
    "type": "parent_of",
})

children = graph.get_children(agent.id)
tree = graph.get_tree(agent.id)

Validate a Minion File

TypeScript

npx minions-cli validate my-agent.json

Python

# CLI is TypeScript only — use the Python SDK directly
from minions.validation import validate_fields
from minions.schemas import agent_type
import json

with open("my-agent.json") as f:
    data = json.load(f)

result = validate_fields(data.get("fields", {}), agent_type.schema)
print(result.valid)

Next Steps

• Learn about the three core primitives
• Understand the layer model
• Follow the AI agent tutorial