​
Quick Start

​
Prerequisites

  • Node.js 18+
  • Python 3.10+ if you use the VM/Ops CLI or Python SDK
  • A SynapseX API key or login credentials

​
1. Clone the repository

git clone https://github.com/softquantus/synapsex.ai
cd synapsex.ai

​
2. Install the developer CLI

npm install -g synapsex-cli
synapsex --version
From source: 
cd apps/agents-synapsex/shared/cli
npm install
npm run build

​
3. Authenticate

synapsex login --api-key sk_...
# or
synapsex login --email user@example.com

​
4. Create and invoke an agent

synapsex agent create my-agent --model gpt-4o --tools web-search file-read
synapsex agent invoke my-agent "Summarize the current platform status"

​
5. Call the REST API directly

curl https://api.synapsex.ai/v1/agents \
  -H "Authorization: Bearer sk_..."

​
6. Optional: VM/Ops CLI

pip install synapsex-cli
sx config set base_url https://api.synapsex.ai
sx auth login --email user@example.com
sx status

​
Production Deploy (Azure)

Production deployment is managed through the infrastructure workflows and Azure Container Apps definitions in this repository. Run preview/what-if before any Azure deployment.
Done! Your platform will be available at https://api.synapsex.ai and https://platform.softquantus.com.