SDK Quick Start
The Inkbox SDK is available for Python and TypeScript. Both SDKs cover the full API surface — identities, mail, phone, webhooks, and signing keys.
Install
PythonRequires Python ≥ 3.11 (Python) or Node.js ≥ 18 (TypeScript).
Authentication
You'll need an API key. Get one at console.inkbox.ai.
Python
| Argument | Type | Default | Description |
|---|---|---|---|
api_key | str | required | Your ApiKey_... token |
base_url | str | API default | Override for self-hosting or testing |
timeout | float | 30.0 | Request timeout in seconds |
Use with Inkbox(...) as inkbox: (recommended) or call inkbox.close() manually to clean up HTTP connections.
TypeScript
| Option | Type | Default | Description |
|---|---|---|---|
apiKey | string | required | Your ApiKey_... token |
baseUrl | string | API default | Override for self-hosting or testing |
timeoutMs | number | 30000 | Request timeout in milliseconds |
Quick start
Python