Quickstart
In this guide, you'll create an agent identity with an inbox and phone number, then send your first email and place a call.
No account yet? Copy and paste this prompt asking your agent to sign itself up:
Sign up for an Inkbox email account by following the guide at https://inkbox.ai/docs/get-started/agent-signup.md and refer to https://inkbox.ai/llms.txt for full documentation.
Inkbox is available as a Python SDK, TypeScript SDK, and CLI.
Set up
Requires Python ≥ 3.11 (Python), Node.js ≥ 18 (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 or pass it as a flag:
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
Python