[ DOCS ]

Documentation

Everything you need to deploy and manage AI agents on SovereignML.

Quick Start

Get your first AI agent running in under 5 minutes:

  1. 1Create an account at sovereignml.com/register
  2. 2From your dashboard, click Deploy Agent
  3. 3Name your project — a URL slug is auto-generated
  4. 4Choose a deployment region closest to your users
  5. 5Select a billing interval (monthly or yearly)
  6. 6Pick a compute tier based on your workload
  7. 7Optionally add SSH keys or extra storage
  8. 8Review your config and click Deploy Agent

In development mode, agents activate immediately without payment. In production, you are redirected to Stripe Checkout to complete billing before the agent provisions.

Agent Types

SovereignML supports 8 agent categories, each purpose-built for a specific business function:

Automation AgentStarter

Automate workflows, data entry, scheduled reports, and business ops.

DevOps AgentPro

Monitor infrastructure, manage CI/CD pipelines, and auto-resolve incidents.

Support AgentStarter

Handle customer tickets, FAQ auto-responses, and live chat 24/7.

Research AgentPro

Scrape the web, analyze data, and generate actionable summaries.

Content AgentPro

Create blog posts, newsletters, and SEO-optimized copy.

Sales AgentPro

Generate leads, run outreach sequences, and enrich your CRM.

Social Media ManagerPro

Schedule posts, optimize engagement, and execute growth strategies.

Custom AgentEnterprise

Bespoke multi-agent systems built to your exact requirements.

Deploy Wizard

The 6-step deploy wizard walks you through every configuration option:

1. Project

Enter your agent name. A URL-safe slug is auto-generated (e.g. my-support-agent → my-support-agent).

2. Region

Pick from 5 active regions. Choose the one geographically closest to your users for lowest latency.

3. Billing

Choose monthly or yearly billing. Yearly saves ~17% (2 months free). Price updates in real-time.

4. Server

Pick a compute tier: Standard (CX), Performance AMD (CPX), ARM (CAX), or Dedicated (CCX). 16 configurations from 2–16 vCPU.

5. Advanced

Optional: set a root password (AES-256-GCM encrypted at rest), add an SSH key, or provision up to 1000 GB extra storage at $0.05/GB/mo.

6. Review

Full config summary with itemized price breakdown. Confirm and deploy.

Managing Agents

All your deployed agents are accessible from the My Agents dashboard at /dashboard/instances.

Status Badges

Each agent shows a real-time status: running, provisioning, stopped, failed, or deleted.

Restart

Running or failed agents can be restarted from the instances page. The agent briefly enters a provisioning state before coming back online.

Stop

Running agents can be stopped. Stopped agents retain their configuration and can be restarted at any time. Your subscription continues while stopped.

Delete

Deleting an agent permanently removes it and cancels the associated subscription. This action cannot be undone.

Billing & Subscriptions

Billing is handled via Stripe. Each deployed agent creates a Stripe subscription tied to your account.

Plans

Starter ($5/mo) supports 1 agent. Pro ($29/mo) supports up to 10 agents across all types. Enterprise ($199/mo) offers unlimited agents, custom builds, and dedicated support.

Yearly Billing

Choosing yearly billing at deploy time saves approximately 17% — equivalent to 2 months free. The billing interval cannot be changed after deployment.

Billing Dashboard

View your estimated monthly cost, active subscriptions, renewal dates, and per-agent billing details at /dashboard/billing.

Payment Issues

If a payment fails, subscriptions enter a past_due state. Update your payment method via Stripe to restore service. Contact support if issues persist.

Security

JWT Sessions

Stateless authentication via NextAuth v5. No server-side session storage. Role (user/admin) is embedded in the JWT token.

Password Hashing

All passwords are hashed with bcryptjs using 10 salt rounds. Passwords are never stored in plaintext.

Root Password Encryption

Instance root passwords are encrypted at rest using AES-256-GCM with a per-instance initialization vector. The encryption key is stored as an environment variable, never in the database.

Reset Token Security

Password reset tokens are stored as SHA-256 hashes. The plaintext token is only ever in the reset email link, never in our database.

Rate Limiting

Registration is limited to 5 attempts per IP per hour. Password reset is limited to 3 emails per address per hour.

Data Isolation

All database queries are scoped to your userId. Agents, subscriptions, and SSH keys from one account are never accessible to another.

API Reference

Auth

POST
/api/auth/register

Create a new account

POST
/api/auth/forgot-password

Request a password reset email

POST
/api/auth/reset-password

Reset password with token

GET
/api/auth/account

Get authenticated user profile

PATCH
/api/auth/account

Update name, password, or social handles

Agents

POST
/api/deploy

Deploy a new AI agent

GET
/api/instances

List all your deployed agents

POST
/api/instances/[id]/restart

Restart an agent

POST
/api/instances/[id]/delete

Delete an agent

Billing

GET
/api/billing

Get billing overview and cost summary

GET
/api/subscriptions

List all subscriptions

Planner

POST
/api/planner

Get agent recommendation for a use case (public)

FAQ

Ready?

Deploy your first AI agent now

Get Started