llms.txt
Compare with other sites' llms.txt files →# AI for Database
> Ask questions, build dashboards, and automate actions from live operational databases. The public REST API is designed for applications and AI agents.
## Canonical agent resources
- [Human agent overview](https://www.aifordatabase.com/agents/)
- [Machine-readable reference](https://www.aifordatabase.com/for-agents/)
- [JSON capability manifest](https://www.aifordatabase.com/api/agents)
- [OpenAPI 3.1 contract](https://app.aifordatabase.com/api/v1/openapi.json)
- [Interactive API reference](https://app.aifordatabase.com/api/v1/docs)
- [Full AI-readable reference](https://www.aifordatabase.com/llms-full.txt)
## CLI
Install the read-only CLI from the official site:
`npm install --global https://www.aifordatabase.com/downloads/aifordatabase-cli-0.1.0.tgz`
Run `aifordatabase --help`, `aifordatabase search authentication`, or `AIFD_API_KEY=... aifordatabase get /connections`. Credentials are sent only to the canonical API host. The CLI supports GET operations only.
## Documentation search
[NLWeb documentation search](https://www.aifordatabase.com/ask/?query=authentication&streaming=false) returns existing documentation references in list mode. GET and POST support JSON responses and optional SSE streaming; this endpoint does not generate answers or access customer databases.
## Documentation tools
- [Read-only documentation MCP](https://www.aifordatabase.com/api/mcp/): Streamable HTTP; search and read existing public documentation.
- [Documentation MCP server card](https://www.aifordatabase.com/.well-known/mcp/server-card.json)
## Authentication
- [Base URL](https://app.aifordatabase.com/api/v1)
- Header: Authorization: Bearer afd_...
- Keys are scoped. Outbound workflow credentials are separate, encrypted, write-only secrets.
## When to use AI for Database
Use the REST API for these supported tasks:
- sanitized_connection_discovery
- schema_introspection
- natural_language_query
- raw_sql_results
- dashboards_and_widgets
- saved_queries_and_metrics
- query_approval
- paused_workflow_drafts
- query_only_workflow_preview
- encrypted_destination_bound_credentials
- explicit_live_action_testing
- immutable_workflow_publishing
- workflow_run_inspection
- signed_event_webhooks
## Recommended implementation guides
- [API overview](https://www.aifordatabase.com/docs/api-overview/)
- [Authentication and scopes](https://www.aifordatabase.com/docs/authentication/)
- [Endpoint catalog](https://www.aifordatabase.com/docs/endpoints/)
- [Query databases from an agent](https://www.aifordatabase.com/docs/agent-querying-databases/)
- [Safe workflow lifecycle](https://www.aifordatabase.com/docs/agent-workflow-lifecycle/)
- [Outbound credentials](https://www.aifordatabase.com/docs/outbound-credentials/)
- [Errors and retries](https://www.aifordatabase.com/docs/api-errors-and-retries/)
- [End-to-end scheduled alert](https://www.aifordatabase.com/docs/agent-created-alerts/)
## Product pages
- [Ask a database](https://aifordatabase.com/solutions/ask-your-database/)
- [Dashboards and reports](https://aifordatabase.com/solutions/dashboards-and-reports/)
- [Database workflows](https://aifordatabase.com/solutions/database-workflows/)
- [Alerts and monitoring](https://aifordatabase.com/solutions/alerts-and-monitoring/)
- [Integrations](https://aifordatabase.com/integrations/)
- [Pricing](https://aifordatabase.com/pricing/)
- [Security](https://aifordatabase.com/security/)
- [Changelog](https://aifordatabase.com/changelog/): dated product updates
- LinkedIn: https://www.linkedin.com/company/aifordatabase-com/
## Documentation pages
36 pages. Each has a Markdown version: add `.md` to the page URL (or send `Accept: text/markdown`).
- [Documentation](https://www.aifordatabase.com/docs/): Guides for connecting databases, asking questions, building dashboards, workflows, alerts and the API. (Markdown: https://www.aifordatabase.com/docs.md)
- [Quickstart Guide](https://www.aifordatabase.com/docs/quickstart/): Get up and running with AI for Database in under five minutes. Connect your first database, ask a question, and see results. (Markdown: https://www.aifordatabase.com/docs/quickstart.md)
- [Your First Query](https://www.aifordatabase.com/docs/first-query/): Learn how to write effective natural-language questions and understand how AI for Database translates them into SQL. (Markdown: https://www.aifordatabase.com/docs/first-query.md)
- [Connect Your Database](https://www.aifordatabase.com/docs/connect-database/): A general overview of how database connections work, including security, permissions, and supported databases. (Markdown: https://www.aifordatabase.com/docs/connect-database.md)
- [PostgreSQL](https://www.aifordatabase.com/docs/postgresql/): Step-by-step guide to connecting PostgreSQL, including user creation, permissions, SSL configuration, and SSH tunnels. (Markdown: https://www.aifordatabase.com/docs/postgresql.md)
- [MySQL](https://www.aifordatabase.com/docs/mysql/): Connect MySQL or MariaDB to AI for Database with read-only access, SSL, and SSH tunnel support. (Markdown: https://www.aifordatabase.com/docs/mysql.md)
- [MongoDB](https://www.aifordatabase.com/docs/mongodb/): Connect MongoDB and MongoDB Atlas. Learn how AI for Database translates natural language into aggregation pipelines. (Markdown: https://www.aifordatabase.com/docs/mongodb.md)
- [SQL Server](https://www.aifordatabase.com/docs/sql-server/): Connect Microsoft SQL Server, Azure SQL, or Amazon RDS SQL Server with Windows or SQL authentication. (Markdown: https://www.aifordatabase.com/docs/sql-server.md)
- [Google Sheets](https://www.aifordatabase.com/docs/google-sheets/): Use Google Sheets as a data source. AI for Database reads your spreadsheets and lets you query them with natural language. (Markdown: https://www.aifordatabase.com/docs/google-sheets.md)
- [Connection Troubleshooting](https://www.aifordatabase.com/docs/connection-troubleshooting/): Diagnose and fix common connection issues including timeouts, SSL errors, permission denied, and firewall blocks. (Markdown: https://www.aifordatabase.com/docs/connection-troubleshooting.md)
- [Natural Language Queries](https://www.aifordatabase.com/docs/natural-language-queries/): Deep dive into how AI for Database converts plain English into SQL, including tips, examples, and advanced techniques. (Markdown: https://www.aifordatabase.com/docs/natural-language-queries.md)
- [Query History](https://www.aifordatabase.com/docs/query-history/): Access, search, and manage your past queries. Re-run, favorite, or share any previous question. (Markdown: https://www.aifordatabase.com/docs/query-history.md)
- [Query Results](https://www.aifordatabase.com/docs/query-results/): Understand result formats including tables, charts, and single values. Export data as CSV, JSON, or to dashboards. (Markdown: https://www.aifordatabase.com/docs/query-results.md)
- [Advanced Queries](https://www.aifordatabase.com/docs/advanced-queries/): Power-user techniques: parameterized queries, variables, cross-database joins, and scheduled queries. (Markdown: https://www.aifordatabase.com/docs/advanced-queries.md)
- [Create a Dashboard](https://www.aifordatabase.com/docs/create-dashboard/): Build your first live dashboard by combining multiple queries into a visual overview. Customize layout and refresh schedules. (Markdown: https://www.aifordatabase.com/docs/create-dashboard.md)
- [Widgets](https://www.aifordatabase.com/docs/widgets/): All widget types: metric cards, tables, bar charts, line charts, pie charts, and text blocks. Configuration and styling options. (Markdown: https://www.aifordatabase.com/docs/widgets.md)
- [Sharing Dashboards](https://www.aifordatabase.com/docs/sharing-dashboards/): Share dashboards via links, embeds, email digests, or Slack. Manage viewer permissions and access controls. (Markdown: https://www.aifordatabase.com/docs/sharing-dashboards.md)
- [Create a Workflow](https://www.aifordatabase.com/docs/create-workflow/): Build automated workflows that run queries, check conditions, and take actions based on your database data. (Markdown: https://www.aifordatabase.com/docs/create-workflow.md)
- [Triggers](https://www.aifordatabase.com/docs/triggers/): Configure scheduled and manual workflow triggers, draft runs, and immutable publishing. (Markdown: https://www.aifordatabase.com/docs/triggers.md)
- [Actions](https://www.aifordatabase.com/docs/actions/): Configure email and reliable authenticated webhook actions, templates, tests, retries, and delivery receipts. (Markdown: https://www.aifordatabase.com/docs/actions.md)
- [Workflow Templates](https://www.aifordatabase.com/docs/workflow-templates/): Pre-built workflow templates for common automation patterns: alerts, reports, data syncs, and notifications. (Markdown: https://www.aifordatabase.com/docs/workflow-templates.md)
- [Setup Alerts](https://www.aifordatabase.com/docs/setup-alerts/): Create data-driven alerts that notify you when database conditions are met. Step-by-step setup guide. (Markdown: https://www.aifordatabase.com/docs/setup-alerts.md)
- [Alert Channels](https://www.aifordatabase.com/docs/alert-channels/): Configure notification channels: email, Slack, webhooks, PagerDuty, and more. Test and manage channel settings. (Markdown: https://www.aifordatabase.com/docs/alert-channels.md)
- [Alert Conditions](https://www.aifordatabase.com/docs/alert-conditions/): All condition types: thresholds, change detection, anomaly detection, and compound conditions. Examples for each. (Markdown: https://www.aifordatabase.com/docs/alert-conditions.md)
- [Security Overview](https://www.aifordatabase.com/docs/security-overview/): How AI for Database protects your data: encryption, read-only access, network security, and compliance certifications. (Markdown: https://www.aifordatabase.com/docs/security-overview.md)
- [Permissions](https://www.aifordatabase.com/docs/permissions/): Role-based access control: admin, editor, and viewer roles. Custom roles and fine-grained permissions on Enterprise. (Markdown: https://www.aifordatabase.com/docs/permissions.md)
- [Audit Logs](https://www.aifordatabase.com/docs/audit-logs/): Track who did what and when. Search audit logs, export for compliance, and set up log forwarding. (Markdown: https://www.aifordatabase.com/docs/audit-logs.md)
- [Self-Hosting](https://www.aifordatabase.com/docs/self-hosting/): Run AI for Database in your own infrastructure. Docker, Kubernetes, and bare-metal deployment guides. (Markdown: https://www.aifordatabase.com/docs/self-hosting.md)
- [API Overview](https://www.aifordatabase.com/docs/api-overview/): Introduction to the AI for Database REST API. Base URLs, versioning, rate limits, and response formats. (Markdown: https://www.aifordatabase.com/docs/api-overview.md)
- [Authentication](https://www.aifordatabase.com/docs/authentication/): API key management, token scopes, and security best practices for API authentication. (Markdown: https://www.aifordatabase.com/docs/authentication.md)
- [API Endpoints](https://www.aifordatabase.com/docs/endpoints/): Complete public API reference: queries, dashboards, workflows, connections, webhooks, usage, and keys. (Markdown: https://www.aifordatabase.com/docs/endpoints.md)
- [Agent-Created Database Alerts](https://www.aifordatabase.com/docs/agent-created-alerts/): Let an AI agent inspect a database, preview eligible rows, and safely publish a scheduled authenticated webhook alert. (Markdown: https://www.aifordatabase.com/docs/agent-created-alerts.md)
- [Query Databases from an Agent](https://www.aifordatabase.com/docs/agent-querying-databases/): Discover sanitized connections and schemas, then return raw query results to an AI agent through the REST API. (Markdown: https://www.aifordatabase.com/docs/agent-querying-databases.md)
- [Agent Workflow Lifecycle](https://www.aifordatabase.com/docs/agent-workflow-lifecycle/): Create a paused workflow, preview rows safely, test one action, publish explicitly, and inspect production runs. (Markdown: https://www.aifordatabase.com/docs/agent-workflow-lifecycle.md)
- [Outbound Workflow Credentials](https://www.aifordatabase.com/docs/outbound-credentials/): Store API keys and bearer tokens as encrypted, write-only, destination-bound workflow credentials. (Markdown: https://www.aifordatabase.com/docs/outbound-credentials.md)
- [API Errors and Retries](https://www.aifordatabase.com/docs/api-errors-and-retries/): Handle response envelopes, validation errors, rate limits, delivery failures, and retries without duplicating external actions. (Markdown: https://www.aifordatabase.com/docs/api-errors-and-retries.md)
## Product and feature pages
68 pages. Each has a Markdown version: add `.md` to the page URL (or send `Accept: text/markdown`).
- [Agent API reference](https://www.aifordatabase.com/for-agents/): Machine-readable API reference for agents that inspect schemas, query databases, and manage workflows. (Markdown: https://www.aifordatabase.com/for-agents.md)
- [Connect AI agents to your database](https://www.aifordatabase.com/agents/) (Markdown: https://www.aifordatabase.com/agents.md)
- [AI for Database in Claude and ChatGPT](https://www.aifordatabase.com/ai-connector/) (Markdown: https://www.aifordatabase.com/ai-connector.md)
- [What is an AI database?](https://www.aifordatabase.com/ai-database/) (Markdown: https://www.aifordatabase.com/ai-database.md)
- [Solutions](https://www.aifordatabase.com/solutions/) (Markdown: https://www.aifordatabase.com/solutions.md)
- [Ask Your Database](https://www.aifordatabase.com/solutions/ask-your-database/) (Markdown: https://www.aifordatabase.com/solutions/ask-your-database.md)
- [Dashboards & Reports](https://www.aifordatabase.com/solutions/dashboards-and-reports/) (Markdown: https://www.aifordatabase.com/solutions/dashboards-and-reports.md)
- [Database Workflows](https://www.aifordatabase.com/solutions/database-workflows/) (Markdown: https://www.aifordatabase.com/solutions/database-workflows.md)
- [Alerts & Monitoring](https://www.aifordatabase.com/solutions/alerts-and-monitoring/) (Markdown: https://www.aifordatabase.com/solutions/alerts-and-monitoring.md)
- [Use cases](https://www.aifordatabase.com/use-cases/) (Markdown: https://www.aifordatabase.com/use-cases.md)
- [AI for Database for Sales](https://www.aifordatabase.com/use-cases/sales/): Close more deals with real-time pipeline intelligence (Markdown: https://www.aifordatabase.com/use-cases/sales.md)
- [AI for Database for Operations](https://www.aifordatabase.com/use-cases/operations/): Run a tighter operation with data-driven decisions (Markdown: https://www.aifordatabase.com/use-cases/operations.md)
- [AI for Database for Product Management](https://www.aifordatabase.com/use-cases/product-management/): Ship better products with usage data at your fingertips (Markdown: https://www.aifordatabase.com/use-cases/product-management.md)
- [AI for Database for Customer Success](https://www.aifordatabase.com/use-cases/customer-success/): Retain more customers by seeing risk before it is too late (Markdown: https://www.aifordatabase.com/use-cases/customer-success.md)
- [AI for Database for Founders](https://www.aifordatabase.com/use-cases/founders/): Your startup's data, answered instantly (Markdown: https://www.aifordatabase.com/use-cases/founders.md)
- [AI for Database for E-commerce](https://www.aifordatabase.com/use-cases/ecommerce/): Turn your store data into revenue-driving insights (Markdown: https://www.aifordatabase.com/use-cases/ecommerce.md)
- [AI for Database for SaaS](https://www.aifordatabase.com/use-cases/saas/): The metrics layer your SaaS business needs (Markdown: https://www.aifordatabase.com/use-cases/saas.md)
- [AI for Database for Marketplaces](https://www.aifordatabase.com/use-cases/marketplaces/): Balance supply and demand with live marketplace intelligence (Markdown: https://www.aifordatabase.com/use-cases/marketplaces.md)
- [Integrations](https://www.aifordatabase.com/integrations/) (Markdown: https://www.aifordatabase.com/integrations.md)
- [PostgreSQL to Slack Alerts Integration](https://www.aifordatabase.com/integrations/postgresql-slack-alerts/): Get real-time Slack notifications when your PostgreSQL data changes (Markdown: https://www.aifordatabase.com/integrations/postgresql-slack-alerts.md)
- [MySQL to Google Sheets Sync Integration](https://www.aifordatabase.com/integrations/mysql-google-sheets/): Automatically sync MySQL query results to Google Sheets on a schedule (Markdown: https://www.aifordatabase.com/integrations/mysql-google-sheets.md)
- [MongoDB to Webhooks Integration](https://www.aifordatabase.com/integrations/mongodb-webhooks/): Trigger HTTP webhooks when your MongoDB collections change (Markdown: https://www.aifordatabase.com/integrations/mongodb-webhooks.md)
- [Database to Email Reports Integration](https://www.aifordatabase.com/integrations/database-email-reports/): Schedule automated email reports from any connected database (Markdown: https://www.aifordatabase.com/integrations/database-email-reports.md)
- [Database to CRM Sync Integration](https://www.aifordatabase.com/integrations/database-crm-sync/): Keep your CRM in sync with live database data automatically (Markdown: https://www.aifordatabase.com/integrations/database-crm-sync.md)
- [AI for Mixpanel](https://www.aifordatabase.com/integrations/mixpanel/): Query your Mixpanel data in plain English. No JQL needed. (Markdown: https://www.aifordatabase.com/integrations/mixpanel.md)
- [AI for Amplitude](https://www.aifordatabase.com/integrations/amplitude/): Query your Amplitude event data in plain English. No SQL required. (Markdown: https://www.aifordatabase.com/integrations/amplitude.md)
- [AI for CleverTap](https://www.aifordatabase.com/integrations/clevertap/): Query your CleverTap campaign and event data with natural language. (Markdown: https://www.aifordatabase.com/integrations/clevertap.md)
- [AI for MoEngage](https://www.aifordatabase.com/integrations/moengage/): Query your MoEngage engagement data with AI. No SQL needed. (Markdown: https://www.aifordatabase.com/integrations/moengage.md)
- [AI for Braze](https://www.aifordatabase.com/integrations/braze/): Query your Braze campaign data across 20+ event tables with AI. (Markdown: https://www.aifordatabase.com/integrations/braze.md)
- [AI for Sentry](https://www.aifordatabase.com/integrations/sentry/): Ask Sentry what broke – not how to write the query. (Markdown: https://www.aifordatabase.com/integrations/sentry.md)
- [Supported databases](https://www.aifordatabase.com/databases/) (Markdown: https://www.aifordatabase.com/databases.md)
- [AI for PostgreSQL](https://www.aifordatabase.com/databases/postgresql/): AI for Database lets you query PostgreSQL in plain English, build live dashboards and set up alerts and scheduled reports – all without writing SQL. (Markdown: https://www.aifordatabase.com/databases/postgresql.md)
- [AI for MySQL](https://www.aifordatabase.com/databases/mysql/): AI for Database lets you query MySQL in plain English, build charts and dashboards, and send scheduled results to Slack, email or webhooks – without writing SQL. (Markdown: https://www.aifordatabase.com/databases/mysql.md)
- [AI for MongoDB](https://www.aifordatabase.com/databases/mongodb/): AI for Database lets you query MongoDB in plain English – no aggregation pipelines to write – then visualize results and set up scheduled alerts on your collections. (Markdown: https://www.aifordatabase.com/databases/mongodb.md)
- [AI for SQL Server](https://www.aifordatabase.com/databases/sql-server/): Unlock my Microsoft SQL Server data with natural language queries. (Markdown: https://www.aifordatabase.com/databases/sql-server.md)
- [AI for MariaDB](https://www.aifordatabase.com/databases/mariadb/): AI-powered queries for MariaDB – the community-driven MySQL fork. (Markdown: https://www.aifordatabase.com/databases/mariadb.md)
- [AI for SQLite](https://www.aifordatabase.com/databases/sqlite/): Query
