SchemaSense

Documentation

Everything you need to know about SchemaSense AI. Comprehensive guides, API documentation, and FAQs.

Getting Started

Learn how to connect your database and generate your first data dictionary.

  • ✓Create an account
  • ✓Add your database connection
  • ✓Configure schema extraction
  • ✓Generate AI documentation

Supported Databases

SchemaSense AI works with multiple database platforms.

  • ✓PostgreSQL (MVP - Fully Supported)
  • ✓Snowflake (Planned)
  • ✓SQL Server (Planned)
  • ✓More coming soon

Security & Privacy

Your data security is our top priority.

  • ✓Read-only database access only
  • ✓No raw data is stored or exposed
  • ✓AI processes only schema metadata
  • ✓Secure backend architecture

Exports & Integrations

Export your documentation in multiple formats.

  • ✓Markdown for documentation systems
  • ✓JSON for programmatic access
  • ✓Compatible with Confluence, Notion, GitHub
  • ✓Custom export templates

Quick Reference

API Endpoints

POST /api/databases
Connect a new database
GET /api/databases/:id/schema
Retrieve extracted schema metadata
GET /api/databases/:id/documentation
Get AI-generated documentation
POST /api/chat
Chat with your schema (natural language)

Authentication

Use your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Get your API key from your account settings.

* Common Error Codes

400Bad Request - Invalid parameters or missing required fields
401Unauthorized - Invalid or missing API key
404Not Found - Resource doesn't exist
429Rate Limited - Too many requests
500Server Error - Please try again later

Frequently Asked Questions

Does SchemaSense AI access my raw data?

No. We only analyze schema metadata and aggregated quality metrics. Raw data is never exposed or transmitted to our servers.

Is SchemaSense AI production-ready?

Yes. The architecture is designed for enterprise use with secure backend services and scalable frontend deployment. We are SOC 2 compliant.

What database credentials do I need?

You only need read-only database credentials (username and password). We recommend creating a dedicated read-only database user for security.

Can I use SchemaSense AI with multiple databases?

Yes! Professional and Enterprise plans support multiple database connections. Start with one and add more as needed.

Where are my credentials stored?

Credentials are encrypted at rest using industry-standard encryption and never exposed to frontend systems or AI models.

Still have questions?

Our support team is here to help. Contact us anytime.