Docs

Documentation

Everything you need to integrate Syntave products and tools into your stack. API reference, quickstart guides, SDK documentation, and deployment guides.

API Reference

Complete API documentation for the Syntave RAG retrieval layer. Authentication via API keys, REST and gRPC endpoints, request and response schemas, error handling, rate limits, and pagination. Every endpoint is documented with request examples in TypeScript, Python, Go, and cURL.

View API Reference →

Quickstart Guide

Get up and running in under five minutes. Install the SDK, authenticate your client, index your first document, and execute a RAG query. The quickstart walks through a real-world scenario with production defaults so you can evaluate Syntave without weeks of configuration.

Read the Quickstart →

SDKs & Client Libraries

First-class SDK support for TypeScript, Python, and Go. Each SDK mirrors the REST API with typed interfaces, built-in retry logic, connection pooling, and request timeout handling. Open-source under the MIT license with community contributions welcome.

Browse SDKs →

Deployment & Self-Hosting

Deploy Syntave anywhere. Managed cloud with automatic scaling, or self-hosted via Docker and Kubernetes for air-gapped environments and strict data residency requirements. Helm charts, Terraform modules, and CloudFormation templates included.

Deployment Guide →

SDK Installation

# TypeScript / JavaScript
npm install @syntave/sdk

# Python
pip install syntave

# Go
go get github.com/syntave/go-sdk

Self-Hosted Deployment

# Self-hosted with Docker
docker run -d \
  --name syntave-node \
  -e SYNTAVE_API_KEY=your_key \
  -p 8080:8080 \
  syntave/node:latest

# Kubernetes (Helm)
helm repo add syntave https://charts.syntave.com
helm install my-release syntave/syntave-node

Our full documentation is hosted at docs.syntave.com

Includes interactive API playground, changelog, migration guides, and community forum.