Getting Started

Introduction

SyntaxVoid provides AI-powered tools for code simplification, documentation generation, and immersive editing. This guide will walk you through setting up your environment and making your first API call.

Private Beta

SyntaxVoid is currently in private beta. You'll need an API key to access the service. Request access here.

Prerequisites

Node.js 18+ or Python 3.9+ (for SDK usage)
A SyntaxVoid API key (obtained from the dashboard after beta approval)
Git (for repository integration features)

Installation

Install the SyntaxVoid CLI and SDK for your preferred language.

Node.js

$ npm install -g @syntaxvoid/cli
$ npm install @syntaxvoid/sdk

Python

$ pip install syntaxvoid

Go

$ go get github.com/syntaxvoid/sdk-go

Quick Start

Simplify your first piece of code in under 30 seconds.

1. Set your API key

$ export SYNTAXVOID_API_KEY=sv_your_key_here

2. Simplify via CLI

$ syntaxvoid simplify ./src/messy-file.ts

✓ Analyzed 247 lines
✓ Removed 12 dead code paths
✓ Simplified 8 expressions
✓ Output: ./src/messy-file.simplified.ts (142 lines, -42%)

3. Use the SDK

import { SyntaxVoid } from '@syntaxvoid/sdk';

const sv = new SyntaxVoid();

const result = await sv.simplify({
  code: messyCode,
  language: 'typescript',
  level: 'aggressive'
});

// result.output  — the simplified code
// result.diff    — what changed and why
// result.stats   — reduction metrics

Configuration

Create a syntaxvoid.config.json in your project root to customize behavior.

{
  "level": "moderate",
  "preserve": ["jsdoc", "types"],
  "ignore": ["node_modules", "dist"],
  "output": {
    "format": "inline",
    "diff": true
  }
}

Options Reference

Option	Type	Default	Description
level	string	"moderate"	Simplification aggressiveness: gentle, moderate, aggressive
preserve	string[]	[]	Elements to preserve: jsdoc, types, tests
ignore	string[]	["node_modules"]	Glob patterns for files to skip
output.diff	boolean	true	Include diff explanations in output

API Reference

Authentication

All API requests require a Bearer token. Include your API key in the Authorization header.

Authorization: Bearer sv_your_api_key

Endpoints

POST /v1/simplify

Simplify a code snippet or file.

{
  "code": "function add(a, b) { ... }",
  "language": "javascript",
  "level": "moderate"
}

POST /v1/document

Generate documentation from code.

{
  "code": "class UserService { ... }",
  "format": "markdown",
  "depth": "detailed"
}

GET /v1/usage

Retrieve your current usage statistics and remaining quota.

Rate Limits

Plan	Requests/min	Requests/day	Max file size
Free	10	50	50 KB
Pro	60	Unlimited	5 MB
Enterprise	Custom	Unlimited	Custom

Error Handling

All errors follow a consistent JSON structure.

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Retry after 60s.",
    "status": 429
  }
}

400 Invalid request body or parameters

401 Missing or invalid API key

429 Rate limit exceeded

500 Internal server error

SDKs

Node.js SDK

import { SyntaxVoid } from '@syntaxvoid/sdk';

const client = new SyntaxVoid({
  apiKey: process.env.SYNTAXVOID_API_KEY
});

// Simplify code
const simplified = await client.simplify({ code, language });

// Generate docs
const docs = await client.document({ code, format: 'md' });

Python SDK

from syntaxvoid import SyntaxVoid

client = SyntaxVoid()

result = client.simplify(
    code=messy_code,
    language="python",
    level="aggressive"
)

print(result.output)
print(f"Reduced by {result.stats.reduction}%")

Go SDK

package main

import sv "github.com/syntaxvoid/sdk-go"

func main() {
    client := sv.NewClient(os.Getenv("SYNTAXVOID_API_KEY"))

    result, _ := client.Simplify(sv.SimplifyInput{
        Code:     messyCode,
        Language: "go",
    })

    fmt.Println(result.Output)
}