Quickstart
In this guide, you'll create an agent identity with an inbox and phone number, then send your first email, place a call, and send a text.
Inkbox is available as a Python SDK, TypeScript SDK, and CLI.
Set up
Requires Python ≥ 3.11 (Python), Node.js ≥ 22 (TypeScript/CLI).
Authentication
You'll need an API key. Get one at inkbox.ai/console.
Python
| Argument | Type | Default | Description |
|---|---|---|---|
api_key | str | required | Your ApiKey_... token |
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 |
timeoutMs | number | 30000 | Request timeout in milliseconds |
CLI
Set the API key as an environment variable, in a config file, or with a flag. The CLI resolves it in this order: --api-key → INKBOX_API_KEY → ~/.inkbox/config.
Environment variable| Flag | Description |
|---|---|
--api-key <key> | Inkbox API key (or INKBOX_API_KEY env var) |
--vault-key <key> | Vault key for decrypt operations (or INKBOX_VAULT_KEY env var) |
--base-url <url> | Override API base URL |
--json | Output as JSON instead of formatted tables |
Quick start
PythonEvery identity has stable addresses derived from its handle:
| Resource | Address |
|---|---|
| Mailbox | support-bot@inkboxmail.com |
| Tunnel | support-bot.inkboxwire.com |
| A2A Agent Card | https://inkbox.ai/a2a/support-bot/card (after enabling A2A) |