Getting Started
Installation

Installation

GlyphNet is a REST API—no installation required. However, we offer official SDKs for easier integration.

Option 1: Direct API Calls

No installation needed. Make HTTP requests to:

https://api.glyphnet.io

Works with any language that supports HTTP requests.

Option 2: Python SDK

pip install glyphnet
from glyphnet import GlyphNet
 
client = GlyphNet(api_key="gn_live_your_key_here")
result = client.verify("The Earth orbits the Sun.")
print(result.verified)  # True

Option 3: JavaScript/TypeScript SDK

npm install glyphnet
# or
yarn add glyphnet
import { GlyphNet } from 'glyphnet';
 
const client = new GlyphNet({ apiKey: 'gn_live_your_key_here' });
const result = await client.verify('The Earth orbits the Sun.');
console.log(result.verified);  // true

Requirements

For Direct API Access

  • Any HTTP client (curl, requests, fetch, axios, etc.)
  • Valid API key

For Python SDK

  • Python 3.8 or higher
  • requests library (installed automatically)

For JavaScript SDK

  • Node.js 16 or higher (for server-side)
  • Modern browser (for client-side)

Environment Variables

We recommend storing your API key in an environment variable:

Linux/macOS

export GLYPHNET_API_KEY="gn_live_your_key_here"

Windows (PowerShell)

$env:GLYPHNET_API_KEY="gn_live_your_key_here"

Windows (CMD)

set GLYPHNET_API_KEY=gn_live_your_key_here

.env File

GLYPHNET_API_KEY=gn_live_your_key_here

The SDKs automatically read from GLYPHNET_API_KEY if no key is provided:

from glyphnet import GlyphNet
 
# Automatically uses GLYPHNET_API_KEY environment variable
client = GlyphNet()

Verify Installation

Test your setup with a simple verification:

from glyphnet import GlyphNet
 
client = GlyphNet()
result = client.verify("Water is H2O.")
 
if result.verified:
    print("Installation successful!")
else:
    print("Check your API key")