Documentation

Introduction

Welcome to PiyRox - the agentic AI platform redefining how humans interact with digital systems.

Quickstart

Get up and running with PiyRox in minutes.

# Install Jarvis OS
npm install -g @piyrox/jarvis

# Initialize your workspace
piyrox init

# Start the assistant
piyrox start

# Or use the web interface
open https://chat.piyrox.sbs

What You'll Get

• Full-featured AI assistant on your machine
• IDE with agentic coding capabilities
• Web-based conversational AI
• API access for custom integrations

Installation

System Requirements

Windows Installation

# Using npm
npm install -g @piyrox/jarvis

# Or download from our website
# Visit https://piyrox.sbs/download

macOS Installation

# Using Homebrew
brew install piyrox/tap/jarvis

# Or download the DMG from our website

Linux Installation

# Using npm
npm install -g @piyrox/jarvis

# Or download the AppImage

System Requirements

Jarvis OS

Your ambient AI assistant that lives on your machine.

Basic Commands

# Start Jarvis
piyrox start

# Check status
piyrox status

# View logs
piyrox logs

# Stop Jarvis
piyrox stop

# Update to latest version
piyrox update

PiyRox IDE

The first IDE built entirely around agentic capabilities.

Agentic Features

// In PiyRox IDE, you can simply ask:
// "Add user authentication to this API"
// "Refactor this module to use TypeScript"
// "Create a REST API for this database schema"

// The IDE will:
// 1. Analyze your entire codebase
// 2. Plan the changes needed
// 3. Execute the modifications
// 4. Run tests to verify
// 5. Show you a diff of changes

PiyRox Chat

The conversational powerhouse with frontier AI models.

API Access

Access PiyRox Chat programmatically through our API:

POST https://api.piyrox.sbs/v1/chat/completions
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "model": "piyrox-4",
  "messages": [
    {"role": "user", "content": "Hello!"}
  ]
}

API Reference

Programmatic access to PiyRox services.

Authentication

All API requests require authentication using an API key. You can generate API keys from your dashboard.

Authorization: Bearer YOUR_API_KEY_HERE

Endpoints

Rate Limits

SDK Documentation

Official SDKs for easy integration.

import { PiyRox } from '@piyrox/sdk';

const client = new PiyRox({
  apiKey: process.env.PIYROX_API_KEY,
});

const response = await client.chat.completions.create({
  model: 'piyrox-4',
  messages: [{ role: 'user', content: 'Hello!' }],
});

console.log(response.choices[0].message.content);

from piyrox import PiyRox

client = PiyRox(api_key=os.environ['PIYROX_API_KEY'])

response = client.chat.completions.create(
    model='piyrox-4',
    messages=[{'role': 'user', 'content': 'Hello!'}]
)

print(response.choices[0].message.content)

Webhooks

Receive real-time notifications about events in your PiyRox account.

{
  "event": "chat.message.created",
  "data": {
    "id": "msg_123",
    "user_id": "user_456",
    "content": "Hello world",
    "timestamp": "2026-05-23T10:00:00Z"
  }
}

Available Events

Authentication

Secure authentication for all PiyRox services.

OAuth 2.0

We support OAuth 2.0 for web applications:

# Authorization URL
https://piyrox.sbs/oauth/authorize
?client_id=YOUR_CLIENT_ID
&redirect_uri=YOUR_REDIRECT_URI
&response_type=code
&scope=read write

# Token exchange
POST https://piyrox.sbs/oauth/token
grant_type=authorization_code
&code=AUTHORIZATION_CODE
&client_id=YOUR_CLIENT_ID
&client_secret=YOUR_CLIENT_SECRET
&redirect_uri=YOUR_REDIRECT_URI

Troubleshooting

Common Issues

Best Practices

For Jarvis OS

• Use the sandboxed environment for untrusted commands
• Review Jarvis workflow scripts before execution
• Enable two-factor authentication for remote access
• Keep Jarvis updated for security patches
• Use environment variables for sensitive configuration

For PiyRox IDE

• Commit changes frequently when using agentic editing
• Review IDE-generated code before committing
• Use the built-in testing framework for all changes
• Keep your codebase organized for better context
• Use the IDE's built-in documentation viewer

For API Usage

• Implement rate limiting in your clients
• Cache responses when appropriate
• Use webhooks for real-time updates instead of polling
• Store API keys securely (environment variables, secret managers)
• Handle errors gracefully with proper retry logic

Changelog