Skip to content

Aksara Studio

Aksara Studio is a built-in web UI that comes with every Aksara application. It runs inside your app — no external tool, no IDE plugin, no extra installation required.

Start your app with aksara dev, then open http://localhost:8000/studio/ui in your browser.

What is Aksara Studio?

Studio is a visual dashboard embedded in your Aksara application. It gives you a live view of everything happening in your backend:

  • Model Browser — Explore your database schema and field definitions
  • Query Explorer — Inspect live queries, query plans, and N+1 alerts
  • Migration Manager — View pending and applied migrations
  • API Inspector — Browse your auto-generated REST endpoints
  • AI Console — Ask questions about your data in plain English
  • Runtime Panel — View settings, connection pool status, and health checks

Studio docs vs AI Mode docs

Read the Studio docs for the built-in web UI, Studio endpoints, and Studio configuration. Read AI Mode for the AI Console, AI Flows, MCP tools, AI Debugger, Architecture Review, and Performance Analyzer that run inside Studio or connect to external agents.

Quick Start

1. Enable Studio (On By Default)

Studio is enabled automatically in debug mode. No configuration needed.

from aksara import Aksara

app = Aksara(
    database_url="postgresql://...",
    debug=True,  # Studio UI is on at /studio/ui
)

2. Start Your App

aksara dev

3. Open Studio in Your Browser

Navigate to http://localhost:8000/studio/ui

That's it. Studio reads your app's live state — models, routes, queries, and migrations — all from the same process.

Aksara Studio — System Overview Studio System Overview — framework version, Python runtime, database connection pool, migration health, and live project statistics in one view.

4. Studio API Endpoints

Studio also exposes a JSON API used by the UI. These are available while your app runs:

Endpoint Description
GET /studio/handshake Full project schema and route manifest
GET /studio/context/summary Lightweight schema summary
GET /studio/health Database and service health check

5. CLI Utilities

# Test the handshake endpoint from the terminal
aksara studio handshake

# Print Studio endpoint URLs for your running app
aksara studio url

Documentation

  • :material-api: Studio API

    Complete API reference for Studio endpoints

  • :material-console: CLI Commands

    Command-line tools for Studio integration

  • :material-cog: Configuration

    Settings and environment variables

  • :material-robot: AI Mode

    Console, flows, MCP tools, and AI analysis features

Security

By default, Studio endpoints are only enabled in debug mode. In production:

  1. Set enable_studio=False to disable completely
  2. Or set studio_expose_in_production=True to explicitly enable
# Disable Studio entirely
app = Aksara(
    database_url="...",
    debug=False,
)

# Enable in production (requires explicit flag)
from aksara.conf import configure, Settings

configure(Settings(
    enable_studio=True,
    studio_expose_in_production=True,
    studio_allowed_origins=["https://studio.mycompany.com"],
))

Next Steps