Skip to content

Console tour

The web console at console.persql.com is the primary control plane. Everything below is also reachable via the REST API, but the console is where humans live.

GitHub OAuth, Google OAuth, or email + password (Better Auth). After sign-in you land on the namespace picker.

The persistent left sidebar shows:

  • Namespace switcher — every namespace you’re a member of.
  • Databases — collapsible tree, each database expands to its tables.
  • Ask AI — opens the in-product agent (also ⌘K).
  • Settings — members, tokens, billing, namespace settings.

Per-database, in tabs:

  • Tables — Excel-like viewer + designer. Edit cell values, add columns, run ad-hoc SQL.
  • Endpoints — list of public endpoints, inline editor, Connect panel with paste-ready snippets.
  • Docs — auto-generated table/column descriptions, manually editable. Powers the agent’s grounding and the public OpenAPI spec.
  • Logs — recent endpoint invocations from analytics.
  • Sharing — invite namespace members in as viewer or editor on this database.

Per-namespace:

  • Members — invite, change role, remove. See Members & roles.
  • API tokens — mint and revoke psql_live_… tokens.
  • Billing — prepaid balance, add funds, usage + ledger history.
  • Namespace — rename, change slug, delete.

Every database has a Connect button that opens a modal with copy-to-clipboard snippets for:

  • curl against /v1
  • @persql/sdk (TypeScript)
  • MCP config (Claude Desktop / Cursor)
  • Anthropic / OpenAI tool definition (via db.asTool())

Use it as the canonical reference when you want to wire something up fast.