DOCUMENTATION

Getting Started

Syntelix empowers users with a governed swarm intelligence network that optimizes workflows and flags anomalies through a simple API. Connect to the decentralized network, subscribe to intelligence streams, and leverage real-time insights seamlessly.

npm install @syntelix/client

Core Concepts

Intelligence Streams

Real-time feeds of automated insights generated by the swarm network. Each stream provides data at a granular level, allowing subscribers to receive actionable intelligence with full verification.

• Latency: 200-800ms from event detection

• Data size: 2-8 KB per event

• Retention: 90 days (historical queries supported)

Verified Insights

Aggregated data into verified insights that include metadata, risk evaluations, and decision-making indicators. Every insight is independently verifiable to ensure reliability.

• Verification method: Multi-node consensus

• Confidence threshold: 3+ node confirmations

• Failure mode: Reject on insight mismatch

API Endpoints

GET/v1/insights/:network/:taskId

Retrieve verified insight for a specific task on the target network.

POST/v1/streams/subscribe

Subscribe to real-time intelligence stream for specified network and criteria.

GET/v1/verification/:network/:address

Query verified insight for a specific address with risk assessment.

POST/v1/verify

Submit data for independent verification against the swarm network.

Integration Guide

Basic Connection

import { SyntelixClient } from '@syntelix/client'

const client = new SyntelixClient({
  apiKey: process.env.SYNT_API_KEY,
  network: 'mainnet'
})

// Query single insight
const insight = await client.getInsight('solana', 'taskId123')
console.log(insight.verified) // true

Stream Subscription

// Subscribe to intelligence stream
const stream = client.subscribeToStream({
  network: 'solana',
  filter: { task: 'anomalyDetection' }
})

stream.on('insight', (insight) => {
  console.log('New verified insight:', insight.data)
  console.log('Validator confirmations:', insight.attestations)
})

stream.on('error', (err) => {
  console.error('Stream error:', err)
})

Developer Notes

Rate Limits

Free tier: 100 queries/minute. Staked tier (10K+ $SYNT): 1000 queries/minute. Enterprise: Unlimited (custom $SYNT stake required).

Insight Verification

All insights include multi-node verification parameters. Client SDK verifies locally by default. Disable with verifyLocal: false to trust network consensus.

Error Handling

Network rejects invalid queries immediately. Failed insights return verified: false with detailed rejection reason. Never trust unverified data.