# Spice.ai Cloud Documentation ## Home - [Welcome to Spice.ai](https://docs.spice.ai/getting-started/readme.md): Welcome to the Spice.ai Cloud Platform! - [Getting Started](https://docs.spice.ai/getting-started/get-started.md): Get started with the Spice.ai Cloud Platform in 5 mins. - [Sign in with GitHub](https://docs.spice.ai/getting-started/get-started/portal-login.md): Sign in to the Portal with GitHub - [Create a Spice app](https://docs.spice.ai/getting-started/get-started/portal-login-1.md): Create your first Spice app - [Add a Dataset and query data](https://docs.spice.ai/getting-started/get-started/step-2-add-dataset-and-query-data.md): Add a dataset and query it using SQL Query in the Playground - [Add AI Model and chat with your data](https://docs.spice.ai/getting-started/get-started/step-3-add-ai-model-and-chat-with-your-app.md): Add an OpenAI model and chat with the NYC Taxi Trips dataset - [Next Steps](https://docs.spice.ai/getting-started/get-started/next-steps.md) - [FAQ](https://docs.spice.ai/getting-started/faq.md): Frequently asked questions - [Federated SQL Query](https://docs.spice.ai/features/federated-sql-query.md): Federated SQL Query documentation - [Data Acceleration](https://docs.spice.ai/features/data-acceleration.md): Configure local acceleration for datasets in Spice for faster queries (test) - [In-Memory Arrow Data Accelerator](https://docs.spice.ai/features/data-acceleration/in-memory-arrow-data-accelerator.md) - [DuckDB Data Accelerator](https://docs.spice.ai/features/data-acceleration/duckdb-data-accelerator.md) - [PostgreSQL Data Accelerator](https://docs.spice.ai/features/data-acceleration/postgresql-data-accelerator.md) - [SQLite Data Accelerator](https://docs.spice.ai/features/data-acceleration/sqlite-data-accelerator.md) - [Search & Retrieval](https://docs.spice.ai/features/search-and-retrieval.md): Use the advanced search and retrieval capabilities of Spice - [AI Gateway](https://docs.spice.ai/features/ai-gateway.md): AI Gateway documentation - [Semantic Models](https://docs.spice.ai/features/semantic-models.md): Define semantic data models in Spice to improve dataset understanding for AI - [ML Models](https://docs.spice.ai/features/spice-models.md): Spice Machine Learning (ML) Models - [Observability](https://docs.spice.ai/features/observability.md): First-class, built-in observability to understand the operations Spice performs. - [Task History](https://docs.spice.ai/features/observability/task-history.md) - [Zipkin](https://docs.spice.ai/features/observability/zipkin.md): Export observability traces from Spice into Zipkin - [Data Connectors](https://docs.spice.ai/building-blocks/data-connectors.md): Learn how to use Data Connector to query external data. - [ABFS](https://docs.spice.ai/building-blocks/data-connectors/abfs.md): Azure BlobFS Data Connector Documentation - [ClickHouse](https://docs.spice.ai/building-blocks/data-connectors/clickhouse.md): ClickHouse Data Connector Documentation - [Databricks](https://docs.spice.ai/building-blocks/data-connectors/databricks.md): Databricks Data Connector Documentation - [Debezium](https://docs.spice.ai/building-blocks/data-connectors/debezium.md): Debezium Data Connector Documentation - [Delta Lake](https://docs.spice.ai/building-blocks/data-connectors/delta-lake.md): Delta Lake Data Connector Documentation - [Dremio](https://docs.spice.ai/building-blocks/data-connectors/dremio.md): Dremio Data Connector Documentation - [DuckDB](https://docs.spice.ai/building-blocks/data-connectors/duckdb.md): DuckDB Data Connector Documentation - [DynamoDB](https://docs.spice.ai/building-blocks/data-connectors/dynamodb.md): DynamoDB Data Connector Documentation - [FlightSQL](https://docs.spice.ai/building-blocks/data-connectors/flightsql.md): Flight SQL Data Connector Documentation - [FTP](https://docs.spice.ai/building-blocks/data-connectors/ftp.md): FTP/SFTP Data Connector Documentation - [GitHub](https://docs.spice.ai/building-blocks/data-connectors/github.md): GitHub Data Connector Documentation - [GraphQL](https://docs.spice.ai/building-blocks/data-connectors/graphql.md): GraphQL Data Connector Documentation - [HTTPS](https://docs.spice.ai/building-blocks/data-connectors/https.md): HTTP(s) Data Connector Documentation - [LocalPod](https://docs.spice.ai/building-blocks/data-connectors/localpod.md): Localpod Data Connector Documentation - [Memory](https://docs.spice.ai/building-blocks/data-connectors/memory.md): Memory Data Connector Documentation - [MSSQL](https://docs.spice.ai/building-blocks/data-connectors/mssql.md): Microsoft SQL Server Data Connector - [MySQL](https://docs.spice.ai/building-blocks/data-connectors/mysql.md): MySQL Data Connector Documentation - [ODBC](https://docs.spice.ai/building-blocks/data-connectors/odbc.md) - [Postgres](https://docs.spice.ai/building-blocks/data-connectors/postgres.md): PostgreSQL Data Connector Documentation - [S3](https://docs.spice.ai/building-blocks/data-connectors/s3.md): S3 Data Connector Documentation - [SharePoint](https://docs.spice.ai/building-blocks/data-connectors/sharepoint.md): SharePoint Data Connector Documentation - [Snowflake](https://docs.spice.ai/building-blocks/data-connectors/snowflake.md): Snowflake Data Connector Documentation - [Spark](https://docs.spice.ai/building-blocks/data-connectors/spark.md): Apache Spark Data Connector Documentation - [SpiceAI](https://docs.spice.ai/building-blocks/data-connectors/spiceai.md): Spice.ai Data Connector Documentation - [Model Providers](https://docs.spice.ai/building-blocks/model-providers.md): Overview of supported model providers for ML and LLMs in Spice. - [Anthropic](https://docs.spice.ai/building-blocks/model-providers/anthropic.md): Instructions for using language models hosted on Anthropic with Spice. - [Azure](https://docs.spice.ai/building-blocks/model-providers/azure.md): Instructions for using Azure OpenAI models - [Hugging Face](https://docs.spice.ai/building-blocks/model-providers/huggingface.md): Instructions for using machine learning models hosted on HuggingFace with Spice. - [OpenAI](https://docs.spice.ai/building-blocks/model-providers/openai.md): Instructions for using language models hosted on OpenAI or compatible services with Spice. - [Perplexity](https://docs.spice.ai/building-blocks/model-providers/perplexity.md): Instructions for using language models hosted on Perplexity with Spice. - [SpiceAI](https://docs.spice.ai/building-blocks/model-providers/spiceai.md): Instructions for using models hosted on the Spice Cloud Platform with Spice. - [XAI](https://docs.spice.ai/building-blocks/model-providers/xai.md): Instructions for using xAI models - [SDKs](https://docs.spice.ai/sdks/sdks.md): Client libraries for querying Spice.ai Cloud and a local Spice runtime - [Python SDK](https://docs.spice.ai/sdks/sdks/python-sdk.md) - [Streaming](https://docs.spice.ai/sdks/sdks/python-sdk/streaming.md) - [Node.js SDK](https://docs.spice.ai/sdks/sdks/node.js-sdk.md) - [API Reference](https://docs.spice.ai/sdks/sdks/node.js-sdk/api-reference.md) - [Streaming](https://docs.spice.ai/sdks/sdks/node.js-sdk/streaming.md) - [Go SDK](https://docs.spice.ai/sdks/sdks/go.md): Golang SDK for Spice.ai - [Rust SDK](https://docs.spice.ai/sdks/sdks/rust-sdk.md): Rust SDK for Spice.ai - [Java SDK](https://docs.spice.ai/sdks/sdks/java-sdk.md) - [Dotnet SDK](https://docs.spice.ai/sdks/sdks/dotnet-sdk.md): Dotnet SDK for Spice.ai - [Agentic AI Apps](https://docs.spice.ai/use-cases/agentic-ai-apps.md): Using Spice.ai for Agentic AI Applications - [Database CDN](https://docs.spice.ai/use-cases/database-cdn.md): Use Spice as a CDN for Databases - [Data Lakehouse](https://docs.spice.ai/use-cases/data-lakehouse.md): Create a Data Lakehouse using Spice - [Enterprise Search](https://docs.spice.ai/use-cases/enterprise-search.md): Use Spice for Enterprise Search and Retrieval - [Enterprise RAG](https://docs.spice.ai/use-cases/enterprise-rag.md): Use Spice for Retrieval-Augmented-Generation (RAG) - [Privacy Policy](https://docs.spice.ai/legal/privacy.md): Spice AI, Inc. - [Website Terms of Use](https://docs.spice.ai/legal/terms.md) - [Terms of Service](https://docs.spice.ai/legal/terms-of-service.md) - [End User License Agreement](https://docs.spice.ai/legal/eula.md) ## Documentation - [Welcome to Spice.ai Cloud](https://docs.spice.ai/docs/getting-started/readme.md): Welcome to the Spice.ai Cloud Platform documentation! - [Getting Started](https://docs.spice.ai/docs/getting-started/get-started.md): Get started with the Spice.ai Cloud Platform in 5 mins. - [Sign in with GitHub](https://docs.spice.ai/docs/getting-started/get-started/portal-login.md): Sign in to the Portal with GitHub - [Create a Spice app](https://docs.spice.ai/docs/getting-started/get-started/portal-login-1.md): Create your first Spice app - [Add a Dataset and query data](https://docs.spice.ai/docs/getting-started/get-started/step-2-add-dataset-and-query-data.md): Add a dataset and query it using SQL Query in the Playground - [Add AI Model and chat with your data](https://docs.spice.ai/docs/getting-started/get-started/step-3-add-ai-model-and-chat-with-your-app.md): Add an OpenAI model and chat with the NYC Taxi Trips dataset - [Next Steps](https://docs.spice.ai/docs/getting-started/get-started/next-steps.md) - [Playground](https://docs.spice.ai/docs/portal/playground.md): Query data, chat with models, and try the runtime APIs from the browser - [SQL Query](https://docs.spice.ai/docs/portal/playground/sql-query-editor.md): Use the Playground's SQL editor to easily explore data - [Text-to-SQL](https://docs.spice.ai/docs/portal/playground/nsql-query.md): Ask a question in natural language and review the SQL Spice generates - [AI Chat](https://docs.spice.ai/docs/portal/playground/ai-chat.md): Use AI Chat to interact with Spice Models - [Search](https://docs.spice.ai/docs/portal/playground/search.md) - [Organizations](https://docs.spice.ai/docs/portal/organizations.md) - [OAuth Clients](https://docs.spice.ai/docs/portal/oauth-clients.md) - [Apps](https://docs.spice.ai/docs/portal/apps.md) - [API keys](https://docs.spice.ai/docs/portal/apps/api-keys.md) - [Secrets](https://docs.spice.ai/docs/portal/apps/secrets.md) - [Tags](https://docs.spice.ai/docs/portal/apps/tags.md) - [Publish](https://docs.spice.ai/docs/portal/apps/publish.md) - [Connect GitHub](https://docs.spice.ai/docs/portal/apps/connect-github.md): Connect your Spice.ai app to a GitHub repository - [Transfer](https://docs.spice.ai/docs/portal/apps/transfer.md) - [Delete](https://docs.spice.ai/docs/portal/apps/delete.md) - [Runtime](https://docs.spice.ai/docs/portal/apps/runtime.md): Configuring Spice.ai runtime for your Spice application - [Public Apps](https://docs.spice.ai/docs/portal/public-apps.md): Publish app to https://spicerack.org - [App Spicepod](https://docs.spice.ai/docs/portal/app-spicepod.md) - [Spicepod Configuration](https://docs.spice.ai/docs/portal/app-spicepod/spicepod-configuration.md) - [Deployments](https://docs.spice.ai/docs/portal/app-spicepod/deployments.md): Monitor and manage app Spicepod instances and deployments. - [Spice Runtime Versions](https://docs.spice.ai/docs/portal/app-spicepod/spice-runtime-versions.md) - [Datasets](https://docs.spice.ai/docs/portal/datasets-and-views.md): Custom Datasets and Views documentation. - [Models](https://docs.spice.ai/docs/portal/models.md) - [Observability](https://docs.spice.ai/docs/portal/monitoring-and-request-logs.md): Continuously identify and fix issues by tracking process actions with Spice monitoring and request logs. - [Profile](https://docs.spice.ai/docs/portal/profile.md) - [Personal Access Tokens](https://docs.spice.ai/docs/portal/profile/personal-access-tokens.md) - [External Data Sources](https://docs.spice.ai/docs/portal/external-data-sources.md): Connect external data sources to Spice.ai - [Monitoring](https://docs.spice.ai/docs/monitoring/monitoring.md): Monitor Spice Cloud apps with Prometheus, Grafana, Datadog, and OpenTelemetry - [Portal](https://docs.spice.ai/docs/monitoring/monitoring/portal.md): Monitor Spice Cloud apps from the Spice.ai portal - [Grafana & Prometheus](https://docs.spice.ai/docs/monitoring/monitoring/grafana.md): Monitor Spice Cloud with Grafana and Prometheus - [Datadog](https://docs.spice.ai/docs/monitoring/monitoring/datadog.md): Monitor Spice Cloud with Datadog - [Zipkin](https://docs.spice.ai/docs/monitoring/monitoring/zipkin.md): Distributed tracing with Zipkin - [Grafana](https://docs.spice.ai/docs/integrations/grafana.md) - [Databricks](https://docs.spice.ai/docs/integrations/databricks.md) - [Best Practices](https://docs.spice.ai/docs/reference/best-practices.md): Best practices and tips for getting the most out of Spice - [Core Concepts](https://docs.spice.ai/docs/reference/core-concepts.md) - [Duration Literals](https://docs.spice.ai/docs/reference/core-concepts/duration-literals.md) - [SQL Reference](https://docs.spice.ai/docs/reference/sql-reference.md) - [Paid Plans](https://docs.spice.ai/docs/pricing/plans.md): Spice.ai Cloud Platform Pricing Plans - [Community Plan](https://docs.spice.ai/docs/pricing/community.md): Spice.ai Cloud Platform Community plan * [Spice.ai Enterprise](https://docs.spice.ai/docs/enterprise/readme.md): Spice.ai Enterprise documentation — self-hosted, production-grade deployment of the Spice runtime. * [Quickstart](https://docs.spice.ai/docs/enterprise/getting-started/quickstart.md): Deploy Spice.ai Enterprise on Kubernetes in minutes. * [Distributions](https://docs.spice.ai/docs/enterprise/getting-started/distributions.md): Spice.ai Enterprise runtime distributions for different workload requirements. * [Docker](https://docs.spice.ai/docs/enterprise/deployment/docker.md): Deploy Spice.ai Enterprise using Docker container images. * [Helm Chart](https://docs.spice.ai/docs/enterprise/deployment/helm-chart.md): Deploy Spice.ai Enterprise on Kubernetes with the official Helm chart. * [AWS Marketplace](https://docs.spice.ai/docs/enterprise/deployment/aws-marketplace.md): Spice.ai Enterprise on AWS Marketplace. * [AWS IRSA (EKS)](https://docs.spice.ai/docs/enterprise/deployment/irsa.md): Configure IAM Roles for Service Accounts (IRSA) for Spice.ai on Amazon EKS. * [GKE Workload Identity](https://docs.spice.ai/docs/enterprise/deployment/gke-workload-identity.md): Configure GKE Workload Identity for Spice.ai on Google Kubernetes Engine. * [Azure Workload Identity](https://docs.spice.ai/docs/enterprise/deployment/azure-workload-identity.md): Configure Azure Workload Identity for Spice.ai on AKS. * [Production Readiness](https://docs.spice.ai/docs/enterprise/production/production.md): Production readiness checklist for deploying Spice.ai Enterprise. * [High Availability](https://docs.spice.ai/docs/enterprise/production/high-availability.md): Multi-replica, multi-AZ topology for production Spice.ai Enterprise deployments. * [Storage](https://docs.spice.ai/docs/enterprise/production/storage.md): Storage and acceleration tiering for production Spice.ai Enterprise deployments. * [Observability](https://docs.spice.ai/docs/enterprise/production/observability.md): Metrics, logs, traces, and alerts for production Spice.ai Enterprise deployments. * [Security](https://docs.spice.ai/docs/enterprise/production/security.md): Security hardening checklist for production Spice.ai Enterprise deployments. * [Upgrades](https://docs.spice.ai/docs/enterprise/production/upgrades.md): Versioning, rolling upgrades, and rollback procedures for Spice.ai Enterprise. * [Overview](https://docs.spice.ai/docs/enterprise/kubernetes-operator/kubernetes.md): Spice.ai Kubernetes Operator for automated deployment and lifecycle management. * [User Guide](https://docs.spice.ai/docs/enterprise/kubernetes-operator/user-guide.md): Step-by-step guide to deploying and operating Spice.ai workloads with the Kubernetes Operator. * [SpicepodSet](https://docs.spice.ai/docs/enterprise/kubernetes-operator/spicepodset.md): SpicepodSet CRD reference for deploying and managing Spicepod replicas. * [SpicepodCluster](https://docs.spice.ai/docs/enterprise/kubernetes-operator/spicepodcluster.md): SpicepodCluster CRD reference for deploying distributed query clusters. * [Operator Metrics](https://docs.spice.ai/docs/enterprise/kubernetes-operator/metrics.md): Prometheus scraping and OTLP push for Spice.ai Kubernetes Operator self-telemetry. * [Authentication](https://docs.spice.ai/docs/enterprise/features/authentication.md): Configure OIDC, API keys, and identity SQL functions for Spice.ai Enterprise. * [Authorization Policy](https://docs.spice.ai/docs/enterprise/features/policy.md): Cedar-based authorization policies for Spice.ai Enterprise — fine-grained access control over datasets, models, tools, and endpoints. * [Acceleration Snapshots](https://docs.spice.ai/docs/enterprise/features/acceleration-snapshots.md): Object-store-backed snapshot, bootstrap, and recovery for accelerated datasets in Spice.ai Enterprise. * [Distributed Accelerations](https://docs.spice.ai/docs/enterprise/features/distributed-accelerations.md): Partition-sharded accelerated datasets across executors with write-through semantics in Spice.ai Enterprise. * [Distributed Query](https://docs.spice.ai/docs/enterprise/features/distributed-query.md): Multi-active distributed query with Apache Ballista, partition-aware execution, and distributed accelerations for multi-node Spice.ai clusters. * [Distributed Inference](https://docs.spice.ai/docs/enterprise/features/distributed-inference.md): Multi-node tensor-parallel LLM inference for Spice.ai Enterprise, splitting a single model across nodes over a pure-TCP ring backend. * [User-Defined Functions](https://docs.spice.ai/docs/enterprise/features/functions.md): User-defined scalar functions (UDFs) and table functions (UDTFs) declared in a spicepod's \`functions:\` section — SQL, Remote HTTP, and WebAssembly tiers. * [mTLS Cluster Security](https://docs.spice.ai/docs/enterprise/features/mtls.md): Automatic mTLS for secure inter-node communication in distributed Spice.ai clusters. - [Spice.ai Open Source Documentation](https://docs.spice.ai/docs/oss/spice.ai-open-source-documentation.md) ## API Reference - [API Reference](https://docs.spice.ai/api/readme.md): Spice.ai Cloud Platform API Reference - [SQL Query API](https://docs.spice.ai/api/runtime-apis/sql-query.md): SQL Query (Cloud Data Warehouse) API - [HTTP API](https://docs.spice.ai/api/runtime-apis/sql-query/http-api.md): Query with SQL via the HTTP API - [Apache Arrow Flight API](https://docs.spice.ai/api/runtime-apis/sql-query/apache-arrow-flight-api.md): SQL Query Apache Arrow Flight API - [LLM API](https://docs.spice.ai/api/runtime-apis/openai-api.md) - [Text-to-SQL API](https://docs.spice.ai/api/runtime-apis/nsql.md): Generate and run SQL from a natural language question - [Search API](https://docs.spice.ai/api/runtime-apis/search.md) - [Health API](https://docs.spice.ai/api/runtime-apis/health.md): Health HTTP API documentation - [Metrics API](https://docs.spice.ai/api/runtime-apis/metrics.md): Scrape per-app runtime metrics - [Management APIs](https://docs.spice.ai/api/management-api/management.md): Management and Deployment API documentation for api.spice.ai - [Health](https://docs.spice.ai/api/management-api/management/health.md) - [Apps](https://docs.spice.ai/api/management-api/management/apps.md) - [Deployments](https://docs.spice.ai/api/management-api/management/deployments.md) - [Secrets](https://docs.spice.ai/api/management-api/management/secrets.md) - [API Keys](https://docs.spice.ai/api/management-api/management/api-keys.md) - [Members](https://docs.spice.ai/api/management-api/management/members.md) - [Regions](https://docs.spice.ai/api/management-api/management/regions.md) - [Limits](https://docs.spice.ai/api/management-api/management/limits.md) - [Documentation](https://docs.spice.ai/api/management-api/management/documentation.md) - [Models](https://docs.spice.ai/api/management-api/management/models.md) - [Dedicated Clusters](https://docs.spice.ai/api/management-api/dedicated-clusters.md): Creating and managing apps on a dedicated, single-tenant cluster - [Terraform Provider](https://docs.spice.ai/api/management-api/terraform.md): Manage Spice.ai resources with Terraform ## Changelog - [Changelog](https://docs.spice.ai/changelog/readme.md): New updates and improvements to the Spice.ai Cloud Platform - [Upgrade Guide from v1.x to v2.x](https://docs.spice.ai/changelog/upgrade-guide-v1-to-v2-x.md): Breaking changes and migration steps when upgrading the Spice runtime from v1.x to v2.x. ## Help Center - [Help Center](https://docs.spice.ai/help/readme.md): Find answers, troubleshoot issues, and get the most out of Spice.ai Cloud Platform. - [Troubleshooting](https://docs.spice.ai/help/troubleshooting.md): Solutions to common issues with the Spice.ai Cloud Platform. - [Account & Billing](https://docs.spice.ai/help/account-and-billing.md): Manage your Spice.ai account, API keys, organizations, and billing. - [Connecting Data](https://docs.spice.ai/help/connecting-data.md): Connect your databases, warehouses, lakes, and APIs to Spice.ai Cloud. - [AI & Models](https://docs.spice.ai/help/ai-and-models.md): Use the AI Gateway for LLM inference, embeddings, and search across multiple model providers. - [APIs & SDKs](https://docs.spice.ai/help/apis-and-sdks.md): Spice.ai APIs, SDKs, endpoints, and query best practices. - [Support](https://docs.spice.ai/help/support.md) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on a page URL with the `ask` query parameter: ``` GET https://docs.spice.ai/getting-started/readme.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.