Documentation

Developer Docs

Everything you need to build, deploy, and scale neural agents on SynapseAI Network.

Quick Start

Deploy your first agent in under 5 minutes with our guided setup.

SDK Reference

Complete TypeScript, Python, Rust, and Go SDK documentation.

API Reference

REST and gRPC endpoints for agent management, mesh queries, and cluster ops.

Architecture Guides

Deep dives into mesh routing, orchestration patterns, and compute fabric.

Quick Start

1. Install the SDK

terminal 
npm install @synapseai/sdk

2. Create an Agent

agent.ts 
import { SynapseAgent, Mesh } from '@synapseai/sdk'

const agent = new SynapseAgent({
  name: 'my-first-agent',
  mesh: Mesh.auto(),
})

agent.on('task', async (ctx) => {
  const result = await ctx.reason(ctx.input)
  return result
})

await agent.connect()

3. Deploy

terminal 
npx synapse deploy --agent agent.ts

SDK Reference

The SynapseAI SDK is available for multiple languages. Each SDK provides the same core abstractions:

LanguagePackageStatus
TypeScript@synapseai/sdkStable
PythonsynapseaiStable
RustsynapseaiBeta
Gogo.synapseai.network/sdkBeta

API Reference

SynapseAI exposes both REST and gRPC APIs for programmatic cluster management.

EndpointMethodDescription
/v1/agentsGETList all agents in the cluster
/v1/agentsPOSTRegister a new agent
/v1/agents/:idGETGet agent details and status
/v1/mesh/routesGETQuery current mesh routing table
/v1/tasksPOSTSubmit a task to the orchestrator
/v1/cluster/metricsGETCluster health and performance metrics

Architecture Guides

Neural Mesh Routing Deep Dive

Understand how agents discover optimal paths through the distributed mesh topology.

Orchestration Patterns

DAG workflows, fan-out/fan-in, saga patterns, and event-driven orchestration.

Compute Fabric Architecture

How GPU resources are pooled, scheduled, and verified across the network.

Security Model

Zero-trust architecture, cryptographic attestation, and access control.