Querypanel

Delete a workspace signing key.

delete_key

Delete a gold_sql or glossary knowledge chunk by ID.

delete_knowledge_chunk

Remove a synced schema snapshot and its table/column embeddings. Gold SQL and glossary chunks are typically preserved. Pass table_schema_id from list_schema_snapshots.

delete_schema_snapshot

Delete a query session and all its turn history by ID.

delete_session

Execute SQL against the organization's datasource. Pass sql and params from generate_sql. Returns rows, fields, rowCount, and a resultId.

execute_sql

Generate an RSA-2048 keypair for this workspace, store the public key and Vault private key, and return the private PEM once so you can write QUERYPANEL_PRIVATE_KEY to the customer .env. Call when init_sdk needs a fresh key the integrator can copy, or when list_keys shows keys but the private PEM is unknown (existing keys are never re-exported). Prefer this over create_key unless the user already has PEMs to upload.

generate_key

Generate SQL for a natural-language question using schema chunks from search_schema. Pass context_chunks through unchanged from search_schema output. Returns sql, params, dialect, database, and rationale.

generate_sql

Get the organization's BYOK AI provider status (OpenAI key configured or not).

get_ai_provider

Retrieve a saved chart by ID, including its SQL, visualization spec, and live data.

get_chart

Retrieve a dashboard by ID, including its content and widget configuration.

get_dashboard

Get a datasource by ID (secrets are never returned).

get_datasource

Get organization details by ID.

get_organization

Retrieve a query session by ID, optionally including its full turn history (each question asked and the SQL generated).

get_session

Bootstrap QueryPanel SDK for this workspace: workspace_id, readiness, env, paste-ready files. mode=headless → node-sdk qp.ask (zero-trust); mode=headful → createJwt + QuerypanelEmbedded; mode=both → both. If ensure_key and no active key, generates + Vault-saves a key and returns private_key once. Write response.files into the customer repo; never commit private keys.

init_sdk

List query audit sessions for the organization (NL→SQL history). For BlockNote dashboard editing use the admin UI; MCP dashboards use api chart/dashboard tools.

list_audit_logs

List saved charts in QueryPanel, with optional filtering and pagination.

list_charts

List all active charts for the organization, with pagination. Active charts are the charts currently visible in embedded dashboards.

list_dashboard_charts

List dashboards in QueryPanel with optional status filtering and pagination.

list_dashboards

List the datasources available to this organization. Returns each datasource name, type, and id. Use the id with search_schema, generate_sql, or execute_sql.

list_datasources

List workspace signing keys (JWKS / public keys). Private key material is never returned — only private_key_secret_id may appear.

list_keys

List members of the current organization (from OAuth org / x-organization-id).

list_members

List organizations (workspaces) the authenticated user belongs to.

list_organizations

Browse indexed schema chunks (table overviews, columns, gold SQL, glossary). Use filters to narrow results. For NL→SQL retrieval prefer search_schema instead.

list_schema_chunks

List scanned schema snapshots (databases that have been synced). Each entry is a table_schemas / database snapshot with table counts.

list_schema_snapshots

List table names for a scanned database snapshot.

list_schema_tables

List query sessions (conversation history). Each session contains a series of natural language questions and the SQL generated for them.

list_sessions

Deactivate a chart by removing it from the active charts list. This hides the chart from embedded dashboards but does not delete the saved chart itself.

remove_chart_from_dashboard

Remove a member from the current organization.

remove_member

Save a chart to QueryPanel. Requires a title, SQL query, and a visualization spec (VizSpec from generate_visualization, or a Vega-Lite spec). Returns the saved chart with its ID.

save_chart

Search the organization's indexed schema context for tables, columns, and example SQL relevant to a question. Returns ranked chunks plus the inferred primary table, database, dialect, and tenant settings. Call this FIRST, then pass its output through to generate_sql.

search_schema

Configure the organization's OpenAI API key (BYOK) and/or fallback-to-platform flag. Requires admin/owner role. Never echo the full key back.

set_ai_provider

Deploy or undeploy a dashboard. Set status to 'deployed' to make it live, or 'draft' to take it offline.

set_dashboard_status

Sync / re-ingest schema for a datasource into the knowledge base (embeddings). Use force_reindex=true to rebuild even when the schema hash is unchanged.

sync_schema

Validate the org AI provider key (or a candidate api_key) against OpenAI.

test_ai_provider

Test connectivity for a datasource.

test_datasource

Activate or deactivate a workspace signing key.

toggle_key

Train a business glossary term/definition into the knowledge base.

train_glossary

Train the knowledge base with example gold SQL for a table/database. Improves NL→SQL quality for similar questions.

train_gold_sql

Update a saved chart's title, description, SQL, or visualization spec.

update_chart

Update a dashboard's name, description, or content. content_json is a BlockNote JSON string for the dashboard layout.

update_dashboard