Onyx Platform Documentation

Getting Started

Start here

Register, create your first org and database, publish a schema (with or without AI), and run queries via the dashboard and SDKs—all in one walkthrough.

Open Getting Started

Client SDKs

Code fast

Install and authenticate the TypeScript, Python, Go, or Kotlin SDKs with ready-made snippets and environment setup.

SDK Reference View SDK Quickstarts

Build your application with Onyx

Start a web or mobile app, sample, or GitHub import in Workspaces. Preview changes, publish web releases, and build for Android and iOS. Use Agent Research and Model Builder to bring analysis, automation, and predictions into your work.

Open the Workspaces Guide AI Schema Generator AI Query Assistant AI Endpoint Reference Model Builder Guide Agent Research Guide Prediction API Reference

Agent Research

Investigate data, choose task permissions, create resources, and review findings, progress, and downloadable evidence.

Prediction API

Call published models from application code with raw inputs or saved scripts. Learn authentication, response fields, and client integration.

Dashboard User Guide

Learn how to use Onyx, from account setup and application Workspaces to databases, research, models, and releases.

AI Chat Workspace

Discover how Onyx AI assistants handle schema exploration, draft scripts, and navigate governance guardrails inside the admin console.

AI Schema Generator

Rapidly blueprint tables and relationships with prompts that translate business context into production-ready schemas.

AI Query Assistant

Ship queries faster with AI-assisted SQL suggestions, inline explanations, and governance-aware execution tips.

Model Builder

Build, train, publish, and test Onyx-backed neural networks from saved database queries.

Cloud Database API

Access your data using simple web services. Our API documentation provides all the information you need to integrate Onyx Cloud Database with your applications seamlessly.