Docs

Documentation

Installation

Install the Sentinel SDK for Python or TypeScript and configure your environment.

Sentinel provides first-party SDKs for Python and TypeScript. Both SDKs are thin, typed wrappers around the REST API with async-first design.

Python SDK

Requirements

  • Python 3.12 or higher
  • uv (recommended) or pip

Install

uv add sentinel-sdk

Or with pip:

pip install sentinel-sdk

Configure

The client reads SENTINEL_API_KEY from the environment by default.

export SENTINEL_API_KEY="sk_live_..."

You can also pass the key explicitly, which is useful in test environments where you want to avoid reading from the environment:

from sentinel import SentinelClient

client = SentinelClient(api_key="sk_test_...")

Verify the install

import asyncio
from sentinel import SentinelClient

async def main() -> None:
    client = SentinelClient()
    me = await client.auth.whoami()
    print(f"Authenticated as {me.account_id}")

asyncio.run(main())

TypeScript SDK

Requirements

  • Node.js 20 or higher (or Bun 1.x)
  • npm, pnpm, or bun

Install

npm install @sentinel-network/sdk
# or
pnpm add @sentinel-network/sdk
# or
bun add @sentinel-network/sdk

Configure

export SENTINEL_API_KEY="sk_live_..."
import { SentinelClient } from "@sentinel-network/sdk";

const client = new SentinelClient(); // reads SENTINEL_API_KEY from process.env

Or pass the key directly:

const client = new SentinelClient({ apiKey: "sk_test_..." });

Verify the install

import { SentinelClient } from "@sentinel-network/sdk";

const client = new SentinelClient();
const me = await client.auth.whoami();
console.log(`Authenticated as ${me.accountId}`);

CLI

Install the Sentinel CLI for local development, verification runs, and publishing.

uv tool install sentinel-cli

Or globally with pip:

pip install sentinel-cli

Verify:

sentinel --version

Log in:

sentinel auth login

This opens a browser window for OAuth. On headless environments, use --api-key instead:

sentinel auth login --api-key sk_live_...

See the full CLI reference.

Environment variables

VariableRequiredDescription
SENTINEL_API_KEYYesAPI key for authentication
SENTINEL_BASE_URLNoOverride the API base URL (useful for self-hosted or staging)
SENTINEL_TIMEOUT_MSNoRequest timeout in milliseconds (default: 30000)
SENTINEL_LOG_LEVELNodebug, info, warn, or error (default: warn)

Note

Never commit your API key to version control. Use a .env file and add it to .gitignore, or use your platform's secret management.

Next steps