Oculix Documentation
Getting started guides for all Oculix products. Choose a product below to see how to sign up, set up, and start using it.
DocPatch
Automated documentation migration. Transform legacy docs into modern formats with one API call.
Get Started with DocPatchPropDesc-AI
AI-powered property descriptions for real estate. Generate SEO-ready listing copy in seconds.
Get Started with PropDesc-AINodeCache EVM
High-speed blockchain cache for dApps. Cut RPC latency 10–100x and reduce costs 90%.
Get Started with NodeCache EVMChainLedgerAI
Neutral on-chain data API. Query blockchain data with AI-assisted filtering at scale.
Get Started with ChainLedgerAIGeneral Getting Started
- Choose a product — Select from DocPatch, PropDesc-AI, NodeCache EVM, or ChainLedgerAI above. Each solves a different problem.
- Sign up for free — All products offer a free tier. No credit card required to start.
- Get your API key — After signup, you'll receive an API key to authenticate your requests.
- Follow the product guide — Each product has a step-by-step guide showing how to make your first request.
- Upgrade when ready — Start free and upgrade to Developer or Team tiers as you scale.
Common Questions
Do I need a credit card to start?
No. All Oculix products offer a free tier with no credit card required. Upgrade to paid tiers only when you're ready to scale beyond free limits.
How do I get an API key?
Your key is emailed to you once, via the verification link you click after signing up — it's shown on that one confirmation page and then never displayed again, so copy it immediately. There's no account dashboard to look it up later yet; if you lose it, contact support to have it reissued. Treat it like a password—don't share it publicly.
What authentication method do you use?
All products use Bearer token authentication (your API key in the Authorization header). No OAuth or complex setup required. See individual product guides for examples.
Can I upgrade or downgrade my plan?
Yes — plan changes go through Stripe checkout, not a self-serve dashboard yet. Contact support to upgrade or downgrade; upgrades take effect immediately, downgrades take effect at your next billing cycle.
What's your uptime guarantee?
All products are built on GCP infrastructure with 99.9% uptime SLA during paid tiers. Free tier has best-effort support. See individual product SLAs for details.
How do I get support?
Email support@oculix.net. Paid tier users get priority response within 24 hours.
API Basics
All Oculix products use the same authentication and response format:
x-api-key: YOUR_API_KEY
All requests use
application/json content type over HTTPS.
Responses return JSON with a
status field (200 for success, 4xx/5xx for errors) and a data object containing results.
Each plan includes a monthly quota, not a per-minute rate limit (Free tier: 20 requests/month on DocPatch, for example). Once you hit your monthly quota, requests return a 402 until it resets. See your product guide for exact limits per tier.
A self-serve usage dashboard isn't live yet — see the status page for system health, or contact support for your current usage. For detailed API reference, see the guide for your specific product above.
Best Practices
- Keep your API key secret. Never commit it to version control or expose it in client-side code.
- Use environment variables. Store your API key as an environment variable (e.g.,
OCULIX_API_KEY). - Implement retry logic. Use exponential backoff for transient errors (5xx responses).
- Monitor your usage. A self-serve usage dashboard is planned but not live yet — contact support to check your call count and quota.
- Cache responses when appropriate. Reduce API calls and costs by caching results locally.
- Read error messages. If a request fails, check the error response for details on what went wrong.