For the complete documentation index, see llms.txt. This page is also available as Markdown.

SDKs

Client libraries for querying Spice.ai Cloud and a local Spice runtime

Client SDKs connect to a Spice app over Apache Arrow Flight and return results as Apache Arrow record batches, which convert cheaply into the dataframe type of each language. They are the recommended way to query Spice from application code.

Every SDK connects to either Spice.ai Cloud or a local Spice runtime. Authentication against Cloud uses an app API key.

Language
Package
Latest
Documentation

Python

spicepy

v3.1.0

TypeScript, Node.js

@spiceai/spice

3.1.0

Go

github.com/spiceai/gospice/v8

v8.0.1

Rust

spiceai

3.0.0

Java

ai.spice:spiceai

0.6.0

C#, .NET

SpiceAI

0.3.0

Default endpoints

Each SDK ships defaults for both Cloud and a local runtime. The exact values and how to override them are on each SDK's page, but the hosts are common:

Target
Arrow Flight
HTTP

Spice.ai Cloud

flight.spiceai.io port 443

https://data.spiceai.io

Local runtime

localhost port 50051

http://localhost:8090

Choosing between an SDK and the APIs directly

An SDK is preferable for application code: it handles the Flight handshake, authentication headers, and retries. Query directly against the HTTP API or Arrow Flight API when a language has no SDK, or for one-off requests from a shell.

Last updated

Was this helpful?