Skip to content

SDKs

SDKs are in progress

We’re actively building and stabilizing the SDKs. Until they’re ready, use the HTTP API directly. This page only lists what exists today and where to track progress.

📦

Node.js

npm package
🐍

Python

pip package
🐹

Go

go module

Node.js / TypeScript

Status

The Node.js/TypeScript SDK lives in the repo spooled-sdk-nodejs and is under active development. If you need something that isn't implemented yet, use the HTTP API from your backend.

Python

Status

The Python SDK lives in the repo spooled-sdk-python and is under active development. For production usage today, call the HTTP API directly.

Go

Status

The Go SDK lives in the repo spooled-sdk-go and is under active development. For now, integrate via the HTTP API.

API Reference

Use the API Reference for the current supported endpoints. (We avoid shipping a potentially stale OpenAPI file in this frontend repository.)

gRPC Support

For high-performance workers, Spooled also provides a gRPC API on port 50051 using HTTP/2 + Protobuf. The proto definitions are available in the backend repository at proto/spooled.proto.

gRPC is ideal for:

  • High-throughput job processing
  • Streaming job delivery (no polling)
  • Type-safe generated clients

See the gRPC API documentation for details.

Authentication

All SDKs accept an API key for authentication. Store keys securely as environment variables:

  • SPOOLED_API_KEY — Your API key

Keys have the format spooled_sk_live_xxxxx or spooled_sk_test_xxxxx.

Need help?