Documentation Index Fetch the complete documentation index at: https://mintlify.com/modal-labs/modal-client/llms.txt
Use this file to discover all available pages before exploring further.
Choose your preferred language and follow the installation instructions below.
Python SDK The Modal Python SDK requires Python 3.10 – 3.14 . Install with uv or pip Install the modal package using your preferred package manager: Verify installation Verify that Modal is installed correctly: python -c "import modal; print(modal.__version__)"
Key dependencies The Python SDK includes the following key dependencies:
aiohttp - Async HTTP clientgrpclib - gRPC supportrich - Terminal formattingtyper - CLI frameworkclick - Command-line interface The Python SDK is the only SDK that supports defining and deploying Modal Functions. The TypeScript and Go SDKs are for calling existing Functions and managing resources.
TypeScript/JavaScript SDK The Modal JavaScript SDK requires Node.js 22 or later . It includes built-in TypeScript type definitions. Install with npm Install the modal package in your server-side Node.js, Deno, or Bun project: The package bundles both ES Modules and CommonJS formats, so you can load it with either import or require(): import { ModalClient } from "modal" ;
Verify installation Create a simple test file to verify the installation: import { ModalClient } from "modal" ; const modal = new ModalClient (); console . log ( "Modal client initialized successfully!" );
The JavaScript/TypeScript SDK is approaching feature parity with the Python SDK, although defining Modal Functions remains exclusive to Python.
Go SDK The Modal Go SDK requires Go 1.23 or later (specified in go.mod as go 1.24.0 for compatibility). Install the package Install the latest version using go get: go get -u github.com/modal-labs/modal-client/go
Import in your application Add the import to your Go files: import modal " github.com/modal-labs/modal-client/go "
Verify installation Create a simple test to verify the installation: package main import ( " fmt " " log " modal " github.com/modal-labs/modal-client/go " ) func main () { mc , err := modal . NewClient () if err != nil { log . Fatalf ( "Failed to create client: %v " , err ) } fmt . Println ( "Modal client initialized successfully!" ) }
Key dependencies The Go SDK includes:
google.golang.org/grpc - gRPC supportgoogle.golang.org/protobuf - Protocol buffersgithub.com/fxamacker/cbor/v2 - CBOR serializationgithub.com/pelletier/go-toml/v2 - TOML configuration The Go SDK is approaching feature parity with the Python SDK, although defining Modal Functions remains exclusive to Python.
Next steps After installing the SDK, you need to authenticate with Modal:
Authentication setup Configure your Modal credentials to start using the SDK