JinxOS Documentation

Welcome to the JinxOS documentation! JinxOS is an enterprise-grade TypeScript framework for deploying autonomous AI agents with persistent memory, customizable personalities, and comprehensive real-world interaction capabilities.

What is JinxOS?

JinxOS empowers developers to architect agents with distinct, persistent personalities, equip them with extensible plugins for real-world integration, and enable autonomous operation toward defined objectives.

Core Capabilities

• Configure distinct personalities and objectives through structured character configuration files
• Integrate with real-world systems utilizing an extensive library of 90+ production-ready plugins
• Orchestrate complex action sequences triggered by natural language processing
• Maintain persistent memory through advanced memory management systems
• Deploy across environments from local development to cloud-native production infrastructure

Quick Start

Deploy your first JinxOS agent using the API:

# Configure your API key
export JINX_API_KEY="your_api_key_here"

# Initialize a new agent
curl -X POST https://api.jinxos.dev/v1/agents \
  -H "Authorization: Bearer $JINX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "MyAgent", "modelProvider": "openai", "model": "gpt-4"}'

# Send a message to your agent
curl -X POST https://api.jinxos.dev/v1/agents/agent_id/messages \
  -H "Authorization: Bearer $JINX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "Hello!", "userId": "user_123"}'

Plugin Ecosystem

JinxOS provides a comprehensive plugin library spanning multiple integration domains:

• Social platforms: Discord, Twitter, Telegram
• Blockchain networks: Ethereum, Solana, Base
• AI providers: OpenAI, Anthropic, OpenRouter, and local model support
• Financial protocols: DeFi trading, lending, yield optimization
• Content generation: Image and video creation capabilities
• Data operations: Web scraping, API integrations, database connectors

Design Philosophy

JinxOS is built on three foundational principles:

1. Rapid Deployment - Production-ready agents in three commands
2. Developer Accessibility - Comprehensive tooling for all skill levels
3. Open Source - Community-driven development with transparent governance

What You Can Build

JinxOS enables you to create:

• Social media agents that engage and scale communities
• Trading bots executing sophisticated DeFi strategies
• Content creators generating multimedia assets
• Personal assistants managing complex workflows
• Research agents gathering and analyzing information
• Customer service automation handling support operations
• And much more...

Get Started

Ready to deploy your first agent? Visit the Installation guide to begin building with JinxOS.