llms.txt
Compare with other sites' llms.txt files →# Spice.ai OSS
> A portable SQL query and AI compute engine, written in Rust, for data-grounded apps and agents.
- [Spice.ai OSS](/index.md)
## cookbook
A collection of guides and samples to help you build data-grounded AI apps and agents with Spice.ai Open-Source. Find ready-to-use examples for data acceleration, AI agents, LLM memory, and more.
- [🧑🍳 Spice.ai OSS Cookbook](/cookbook.md): A collection of guides and samples to help you build data-grounded AI apps and agents with Spice.ai Open-Source. Find ready-to-use examples for data acceleration, AI agents, LLM memory, and more.
## docs
Spice is an open-source SQL query and AI compute engine, written in Rust, for data-driven applications and AI agents. Learn about data federation, acceleration, RAG, and building intelligent apps.
- [Spice.ai Open Source](/docs.md): Spice is an open-source SQL query and AI compute engine, written in Rust, for data-driven applications and AI agents. Learn about data federation, acceleration, RAG, and building intelligent apps.
### tags
- [Tags](/docs/tags.md)
- [One doc tagged with "Acknowledgements"](/docs/tags/acknowledgements.md): Project acknowledgements, credits, and attributions.
- [3 docs tagged with "ADBC"](/docs/tags/adbc.md): Arrow Database Connectivity driver configuration and usage.
- [5 docs tagged with "API"](/docs/tags/api.md): HTTP, Arrow Flight SQL, ODBC, JDBC, and ADBC API reference.
- [One doc tagged with "Argo CD"](/docs/tags/argocd.md): Argo CD declarative GitOps continuous delivery for Kubernetes.
- [2 docs tagged with "Arrow"](/docs/tags/arrow.md): Apache Arrow columnar data format integration.
- [One doc tagged with "Arrow Flight SQL"](/docs/tags/arrow-flight-sql.md): Arrow Flight SQL protocol implementation and configuration.
- [One doc tagged with "Auth"](/docs/tags/auth.md): Authentication and authorization mechanisms.
- [2 docs tagged with "Authentication"](/docs/tags/authentication.md): User authentication methods and security protocols.
- [5 docs tagged with "Azure"](/docs/tags/azure.md): Microsoft Azure cloud services and integrations.
- [2 docs tagged with "Blob Storage"](/docs/tags/blob-storage.md): Object storage services and blob data access.
- [One doc tagged with "Caching"](/docs/tags/caching.md): Data caching strategies and performance optimization.
- [13 docs tagged with "Catalogs"](/docs/tags/catalogs.md): Data catalog connectors and metadata management.
- [4 docs tagged with "Cayenne"](/docs/tags/cayenne.md): Cayenne (Vortex) data accelerator built on Vortex columnar format.
- [2 docs tagged with "CLI"](/docs/tags/cli.md): Spice command-line interface commands and usage.
- [4 docs tagged with "Cloud Connect"](/docs/tags/cloud-connect.md): Connect a self-hosted Spice instance to Spice Cloud.
- [6 docs tagged with "Component Metrics"](/docs/tags/component-metrics.md): Runtime component performance metrics and monitoring.
- [One doc tagged with "Components"](/docs/tags/components.md): Runtime components including catalogs, data connectors, and models.
- [2 docs tagged with "Configuration"](/docs/tags/configuration.md): System configuration files and runtime settings.
- [2 docs tagged with "Cosmos DB"](/docs/tags/cosmosdb.md): Azure Cosmos DB (NoSQL / Core SQL) data connector.
- [One doc tagged with "C#"](/docs/tags/csharp.md): C# programming language topics.
- [9 docs tagged with "Data Accelerators"](/docs/tags/data-accelerators.md): Data acceleration engines for high-performance query execution.
- [50 docs tagged with "Data Connectors"](/docs/tags/data-connectors.md): Data source connectors and integration patterns.
- [One doc tagged with "Data Lake"](/docs/tags/data-lake.md): Data lake architectures and storage solutions.
- [3 docs tagged with "Databricks"](/docs/tags/databricks.md): Databricks platform integration and Unity Catalog support.
- [2 docs tagged with "Datasets"](/docs/tags/datasets.md): Dataset definitions and data source configurations.
- [One doc tagged with "Debezium"](/docs/tags/debezium.md): Debezium change data capture integration.
- [One doc tagged with "Debugging"](/docs/tags/debugging.md): Debugging techniques and troubleshooting tools.
- [3 docs tagged with "Delta Lake"](/docs/tags/delta-lake.md): Delta Lake open table format support.
- [One doc tagged with "Dependencies"](/docs/tags/dependencies.md): Third-party dependencies and software requirements.
- [13 docs tagged with "Deployment"](/docs/tags/deployment.md): Production deployment using Docker and Kubernetes.
- [3 docs tagged with "Docker"](/docs/tags/docker.md): Docker containerization and deployment configurations.
- [One doc tagged with ".NET"](/docs/tags/dotnet.md): .NET framework topics.
- [One doc tagged with "Dremio"](/docs/tags/dremio.md): Dremio data lake engine integration.
- [2 docs tagged with "DuckDB"](/docs/tags/duckdb.md): DuckDB embedded analytical database integration.
- [2 docs tagged with "DuckLake"](/docs/tags/ducklake.md): DuckLake catalog integration.
- [2 docs tagged with "DynamoDB"](/docs/tags/dynamodb.md): Amazon DynamoDB NoSQL database integration.
- [2 docs tagged with "Elasticsearch"](/docs/tags/elasticsearch.md): Elasticsearch data connector and vector engine integration.
- [7 docs tagged with "Embeddings"](/docs/tags/embeddings.md): Vector embeddings and semantic similarity operations.
- [6 docs tagged with "Features"](/docs/tags/features.md): Core platform features including acceleration, caching, and search.
- [One doc tagged with "Federation"](/docs/tags/federation.md): Cross-database queries and federated data access.
- [One doc tagged with "File"](/docs/tags/file.md): File-based data connectors and local file access.
- [One doc tagged with "Flux"](/docs/tags/flux.md): Flux CD GitOps toolkit for Kubernetes.
- [One doc tagged with "Flux CD"](/docs/tags/fluxcd.md): Flux CD GitOps toolkit for Kubernetes.
- [3 docs tagged with "Functions"](/docs/tags/functions.md): User-defined SQL scalar functions and remote function endpoints.
- [One doc tagged with "Getting Started"](/docs/tags/getting-started.md): Installation guides and quickstart tutorials.
- [3 docs tagged with "GitHub"](/docs/tags/github.md): GitHub repository data connector and integration.
- [3 docs tagged with "GitOps"](/docs/tags/gitops.md): GitOps continuous delivery patterns for Kubernetes.
- [2 docs tagged with "Glue"](/docs/tags/glue.md): AWS Glue ETL service and data catalog integration.
- [One doc tagged with "Go"](/docs/tags/go.md): Go programming language topics.
- [One doc tagged with "Golang"](/docs/tags/golang.md): Go (Golang) programming language topics.
- [One doc tagged with "GraphQL"](/docs/tags/graphql.md): GraphQL API data connectors and query language support.
- [3 docs tagged with "Helm"](/docs/tags/helm.md): Helm package manager for deploying Spice.ai on Kubernetes.
- [One doc tagged with "HTTPS"](/docs/tags/https.md): HTTPS data connectors and secure web API access.
- [3 docs tagged with "Hugging Face"](/docs/tags/huggingface.md): Hugging Face model hub and transformer model integration.
- [2 docs tagged with "Iceberg"](/docs/tags/iceberg.md): Apache Iceberg open table format support.
- [One doc tagged with "In-Memory"](/docs/tags/in-memory.md): In-memory data processing and temporary storage.
- [One doc tagged with "Integration"](/docs/tags/integration.md): Third-party system integrations and connectivity patterns.
- [One doc tagged with "Java"](/docs/tags/java.md): Java programming language topics.
- [One doc tagged with "JavaScript"](/docs/tags/javascript.md): JavaScript programming language topics.
- [One doc tagged with "JDBC"](/docs/tags/jdbc.md): Java Database Connectivity driver configuration.
- [One doc tagged with "Kafka"](/docs/tags/kafka.md): Apache Kafka event streaming platform integration.
- [8 docs tagged with "Kubernetes"](/docs/tags/kubernetes.md): Kubernetes orchestration and secret management.
- [One doc tagged with "launchd"](/docs/tags/launchd.md): Run Spice as a macOS service.
- [One doc tagged with "libSQL"](/docs/tags/libsql.md): libSQL database topics.
- [One doc tagged with "LLM"](/docs/tags/llm.md): Large Language Model integration and inference.
- [One doc tagged with "Local"](/docs/tags/local.md): Local model execution and on-premise services.
- [One doc tagged with "Logging"](/docs/tags/logging.md): Application logging configuration and log management.
- [One doc tagged with "Login"](/docs/tags/login.md): User login processes and session management.
- [One doc tagged with "Manifest"](/docs/tags/manifest.md): Configuration manifest files and schema definitions.
- [One doc tagged with "MCP"](/docs/tags/mcp.md): Model Context Protocol for AI tool integration.
- [2 docs tagged with "Memory"](/docs/tags/memory.md): In-memory data connectors and volatile storage.
- [17 docs tagged with "Models"](/docs/tags/models.md): Machine learning models and AI inference engines.
- [One doc tagged with "MongoDB"](/docs/tags/mongodb.md): MongoDB NoSQL document database integration.
- [One doc tagged with "MSSQL"](/docs/tags/mssql.md): Microsoft SQL Server database integration.
- [3 docs tagged with "MySQL"](/docs/tags/mysql.md): MySQL relational database integration.
- [One doc tagged with "Node.js"](/docs/tags/nodejs.md): Node.js runtime environment topics.
- [3 docs tagged with "NoSQL"](/docs/tags/nosql.md): NoSQL database systems and document stores.
- [29 docs tagged with "Observability"](/docs/tags/observability.md): Monitoring, tracing, and metrics for system visibility.
- [One doc tagged with "ODBC"](/docs/tags/odbc.md): Open Database Connectivity driver configuration.
- [One doc tagged with "Open Source"](/docs/tags/open-source.md): Open source licenses and community contributions.
- [3 docs tagged with "OpenAI"](/docs/tags/openai.md): OpenAI API integration and GPT model access.
- [2 docs tagged with "Oracle"](/docs/tags/oracle.md): Documentation related to Oracle database integration.
- [2 docs tagged with "Overrides"](/docs/tags/overrides.md): Parameter overrides and configuration customization.
- [2 docs tagged with "Overview"](/docs/tags/overview.md): High-level component and feature overviews.
- [2 docs tagged with "Parameters"](/docs/tags/parameters.md): Configuration parameters and runtime options.
- [2 docs tagged with "Performance"](/docs/tags/performance.md): Performance optimization and benchmarking.
- [One doc tagged with "Persistence"](/docs/tags/persistence.md): Data persistence and durable storage mechanisms.
- [4 docs tagged with "Postgres"](/docs/tags/postgres.md): PostgreSQL database integration and configuration.
- [One doc tagged with "Python"](/docs/tags/python.md): Python programming language topics.
- [3 docs tagged with "Query"](/docs/tags/query.md): SQL query execution, parameterized queries, and prepared statements.
- [4 docs tagged with "Reference"](/docs/tags/reference.md): API reference, CLI commands, and configuration syntax.
- [One doc tagged with "Relational"](/docs/tags/relational.md): Relational database systems and SQL operations.
- [3 docs tagged with "Runtime"](/docs/tags/runtime.md): Runtime behavior and execution environment.
- [One doc tagged with "Rust"](/docs/tags/rust.md): Rust programming language topics.
- [2 docs tagged with "S3"](/docs/tags/s3.md): Amazon S3 object storage integration.
- [One doc tagged with "S3 Express"](/docs/tags/s3-express.md): Amazon S3 Express One Zone storage.
- [One doc tagged with "Sandbox"](/docs/tags/sandbox.md): Sandbox environments and isolated testing.
- [One doc tagged with "ScyllaDB"](/docs/tags/scylladb.md): ScyllaDB database integration.
- [6 docs tagged with "SDK"](/docs/tags/sdk.md): Software Development Kit topics and usage.
- [10 docs tagged with "Search"](/docs/tags/search.md): Vector search, semantic search, and ranking capabilities.
- [2 docs tagged with "Security"](/docs/tags/security.md): Security features and data protection mechanisms.
- [One doc tagged with "Snowflake"](/docs/tags/snowflake.md): Snowflake cloud data warehouse integration.
- [12 docs tagged with "SpiceAI"](/docs/tags/spiceai.md): SpiceAI cloud platform and managed services.
- [5 docs tagged with "Spicepod"](/docs/tags/spicepod.md): Spicepod configuration files, manifest syntax, and package management.
- [8 docs tagged with "SQL"](/docs/tags/sql.md): SQL query language support and database operations.
- [One doc tagged with "systemd"](/docs/tags/systemd.md): Run Spice as a Linux service.
- [5 docs tagged with "Tools"](/docs/tags/tools.md): Development tools and utility integrations.
- [2 docs tagged with "Tracing"](/docs/tags/tracing.md): Distributed tracing and request monitoring.
- [One doc tagged with "Troubleshooting"](/docs/tags/troubleshooting.md): Problem diagnosis and resolution guides.
- [One doc tagged with "Turso"](/docs/tags/turso.md): Turso data accelerator integration.
- [2 docs tagged with "UDF"](/docs/tags/udf.md): User-defined functions registered with the SQL engine.
- [2 docs tagged with "Unity Catalog"](/docs/tags/unity-catalog.md): Databricks Unity Catalog data governance integration.
- [One doc tagged with "Views"](/docs/tags/views.md): Virtual views and data transformation layers.
- [One doc tagged with "Vortex"](/docs/tags/vortex.md): Vortex columnar file format and storage engine.
- [10 docs tagged with "Write"](/docs/tags/write.md): Data connectors and catalogs that support write operations.
- [One doc tagged with "YAML"](/docs/tags/yaml.md): YAML configuration syntax and file formats.
- [One doc tagged with "Zipkin"](/docs/tags/zipkin.md): Zipkin distributed tracing system integration.
### acknowledgements
Spice AI acknowledges the following open source projects for making this project possible:
- [Open Source Acknowledgements](/docs/acknowledgements.md): Spice AI acknowledges the following open source projects for making this project possible:
### api
Spice.ai API reference including HTTP REST API, Arrow Flight SQL, JDBC, ODBC, ADBC connectors, authentication, and TLS configuration.
- [Spice.ai API Reference](/docs/api.md): Spice.ai API reference including HTTP REST API, Arrow Flight SQL, JDBC, ODBC, ADBC connectors, authentication, and TLS configuration.
- [ADBC: Arrow Database Connectivity](/docs/api/adbc.md): ADBC API Documentation
- [Arrow Flight SQL API](/docs/api/arrow-flight-sql.md): Query Spice using JDBC/ODBC/ADBC
- [Authentication](/docs/api/auth.md): Authentication documentation
- [Generate Package](/docs/api/HTTP/generate-package.md): This endpoint generates a zip package from a specified GitHub source.
- [List Catalogs](/docs/api/HTTP/get-catalogs.md): Returns a list of all registered catalogs (data sources). Catalogs provide metadata about schemas and tables available from external data sources.
- [Get Iceberg API config](/docs/api/HTTP/get-config.md): This endpoint returns the Iceberg Catalog API configuration, including details about overrides, defaults, and available endpoints.
- [List Datasets](/docs/api/HTTP/get-datasets.md): This endpoint returns a list of configured datasets. The response can be formatted as **JSON** or **CSV**,
- [List Iceberg namespaces](/docs/api/HTTP/get-iceberg-namespaces.md): This endpoint retrieves namespaces available in the Iceberg catalog.
- [List Models](/docs/api/HTTP/get-models.md): List all models, both machine learning and language models, available in the runtime.
- [Check if a namespace exists.](/docs/api/HTTP/get-namespace.md): This endpoint returns a 200 OK response if the namespace exists, otherwise it returns a 404 Not Found response.
- [List Spicepods](/docs/api/HTTP/get-spicepods.md): Get a list of spicepods and their summary details.
- [Check Runtime Status](/docs/api/HTTP/get-status.md): Return the status of all connections (http, flight, metrics, opentelemetry) in the runtime.
- [Get a table.](/docs/api/HTTP/get-table.md): This endpoint returns the table if it exists, otherwise it returns a 404 Not Found response.
- [List Workers](/docs/api/HTTP/get-workers.md): Returns a list of all registered workers in the runtime. Workers are configurable processing units that can perform tasks like load balancing between models or implementing fallback strategies.
- [Check Namespace exists](/docs/api/HTTP/head-namespace.md): This endpoint returns a 200 OK response if the namespace exists, otherwise it returns a 404 Not Found response.
- [Check if a table exists.](/docs/api/HTTP/head-table.md): This endpoint returns a 200 OK response if the table exists, otherwise it returns a 404 Not Found response.
- [list_tables](/docs/api/HTTP/list-tables.md): list_tables
- [List Tools](/docs/api/HTTP/list-tools.md): Returns a list of all available tools in the Spice runtime. Tools provide reusable functionality that can be invoked programmatically or by AI agents.
- [Send a Model Context Protocol message](/docs/api/HTTP/mcp-message.md): Send a JSON-RPC message to the Spice MCP server using the MCP Streamable HTTP transport. The response is either a single JSON-RPC response (`application/json`) or an SSE stream (`text/event-stream`), selected via the `Accept` header. Session continuity is carried via the `Mcp-Session-Id` header.
- [Open an MCP server-to-client SSE stream](/docs/api/HTTP/mcp-stream.md): Open a long-lived server-to-client SSE stream for the current MCP session as defined by the Streamable HTTP transport. The `Mcp-Session-Id` header must identify an existing session created via `POST /v1/mcp`.
- [Terminate an MCP Streamable HTTP session](/docs/api/HTTP/mcp-terminate-session.md): Terminate the MCP session identified by the `Mcp-Session-Id` header. Subsequent requests bearing the same session id will receive `404 Not Found`.
- [Update Refresh SQL](/docs/api/HTTP/patch-dataset-acceleration.md): Update the refresh SQL for a dataset's acceleration.
- [Create Chat Completion](/docs/api/HTTP/post-chat-completions.md): Creates a model response for the given chat conversation.
- [Ingest Debezium CDC changes](/docs/api/HTTP/post-dataset-cdc.md): Push Debezium change events (JSON or Avro) directly into an accelerated
- [Refresh Dataset](/docs/api/HTTP/post-dataset-refresh.md): Trigger an on-demand refresh for an accelerated dataset.
- [Create Embeddings](/docs/api/HTTP/post-embeddings.md): Creates an embedding vector representing the input text.
- [Text-to-SQL (NSQL)](/docs/api/HTTP/post-nsql.md): Generate and optionally execute a natural-language text-to-SQL (NSQL) query.
- [post_responses](/docs/api/HTTP/post-responses.md): post_responses
- [Search](/docs/api/HTTP/post-search.md): Perform a vector similarity search (VSS) operation on a dataset.
- [SQL Query](/docs/api/HTTP/post-sql.md): Execute a SQL query and return the results.
- [Check Readiness](/docs/api/HTTP/ready.md): Check the runtime status of all the components of the runtime. If the service is ready, it returns an HTTP 200 status with the message 'ready'. If not, it returns a 503 status with the message 'not ready'.
- [Run Tool](/docs/api/HTTP/run-tool.md): Execute a specific tool by name. The request body schema and response format are defined by each individual tool's specification. Use `GET /v1/tools` to discover available tools and their parameter schemas.
- [runtime](/docs/api/HTTP/runtime.md): The spiced runtime
- [JDBC: Java Database Connectivity](/docs/api/jdbc.md): JDBC API Documentation
- [ODBC: Open Database Connectivity](/docs/api/odbc.md): ODBC API Documentation
- [API Overview](/docs/api/overview.md): Spice.ai API overview, including SQL query interfaces, OpenAI-compatible endpoints, Iceberg catalog REST APIs, and the Model Context Protocol (MCP) for integrating external tools.
- [TLS: Transport Layer Security](/docs/api/tls.md): Encryption in transit with TLS documentation
### cli
Complete CLI reference for Spice.ai including commands to create, manage Spicepods, run queries, and interact with the Spice runtime.
- [Spice.ai CLI Reference](/docs/cli.md): Complete CLI reference for Spice.ai including commands to create, manage Spicepods, run queries, and int