API Reference

Glyphrun provides a REST API for running glyphs and managing your account.

Base URL


https://api.glyphrun.com

Authentication

All authenticated endpoints require a Bearer token:


Authorization: Bearer YOUR_TOKEN

Tokens are obtained through Privy authentication.

Endpoints Overview

Glyph Execution

Method	Endpoint	Description
POST	`/run`	Execute a glyph

Glyph Catalog

Method	Endpoint	Description
GET	`/glyphs`	List all glyphs
GET	`/glyph/{slug}`	Get glyph details
POST	`/glyph`	Create a glyph

Wallet

Method	Endpoint	Description
GET	`/wallet/balance`	Check balance
POST	`/wallet/deposit`	Record deposit

Response Format

All responses follow this structure:

Success


{
  "data": { ... },
  "metadata": {
    "timestamp": "2024-01-01T00:00:00Z"
  }
}

Error


{
  "error": "Error message",
  "code": "ERROR_CODE",
  "details": { ... }
}

HTTP Status Codes

Code	Description
200	Success
201	Created
400	Bad request
401	Unauthorized
402	Payment required
403	Forbidden
404	Not found
500	Server error

Rate Limits

Authenticated: 100 requests/minute
Unauthenticated: 10 requests/minute

Rate limit headers:


X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1704067200

SDKs

JavaScript/TypeScript


npm install @glyphrun/sdk


import { Glyphrun } from '@glyphrun/sdk'
 
const client = new Glyphrun({
  apiKey: 'YOUR_API_KEY'
})
 
const result = await client.run('token-name-generator', {
  theme: 'DeFi',
  style: 'Professional'
})

Python

Coming soon.

Webhooks

For long-running operations, configure webhook callbacks:


{
  "webhookUrl": "https://your-server.com/callback",
  "webhookEvents": ["run.completed", "run.failed"]
}

Getting Help

Discord - Community support
GitHub Issues - Bug reports
Email - Direct support