Quickstart

pip install inkbox

npm install @inkbox/sdk

cargo add inkbox

npm install -g @inkbox/cli

export INKBOX_API_KEY=ApiKey_...

# ~/.inkbox/config
api_key = ApiKey_...

inkbox --api-key ApiKey_... identity list

import os
from inkbox import Inkbox

with Inkbox(api_key=os.environ["INKBOX_API_KEY"]) as inkbox:
    # Create an agent identity — provisions the mailbox and tunnel atomically;
    # the optional phone_number block adds a number in the same call.
    identity = inkbox.create_identity(
        "support-bot",
        display_name="Support Bot",
        phone_number={"type": "local"},
    )

    # Send email directly from the identity
    identity.send_email(
        to=["customer@example.com"],
        subject="Your order has shipped",
        body_text="Tracking number: 1Z999AA10123456784",
    )

    # Place an outbound call
    identity.place_call(
        to_number="+14155550123",
        client_websocket_url="wss://my-app.com/voice",
    )

    # Send a text
    identity.send_text(to="+15551234567", text="Hi! This is your support bot.")

    # Read inbox
    for message in identity.iter_emails():
        print(message.subject)

    # List calls
    calls = identity.list_calls()

import { Inkbox } from "@inkbox/sdk";

const inkbox = new Inkbox({ apiKey: process.env.INKBOX_API_KEY! });

// Create an agent identity — provisions the mailbox and tunnel atomically;
// the optional phoneNumber block adds a number in the same call.
const identity = await inkbox.createIdentity("support-bot", {
  displayName: "Support Bot",
  phoneNumber: { type: "local" },
});

// Send email directly from the identity
await identity.sendEmail({
  to: ["customer@example.com"],
  subject: "Your order has shipped",
  bodyText: "Tracking number: 1Z999AA10123456784",
});

// Place an outbound call
await identity.placeCall({
  toNumber: "+14155550123",
  clientWebsocketUrl: "wss://my-app.com/voice",
});

// Send a text
await identity.sendText({ to: "+15551234567", text: "Hi! This is your support bot." });

// Read inbox
for await (const message of identity.iterEmails()) {
  console.log(message.subject);
}

// List calls
const calls = await identity.listCalls();

use inkbox::phone::resources::texts::TextRecipients;
use inkbox::phone::CallOrigin;
use inkbox::Inkbox;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let inkbox = Inkbox::new(std::env::var("INKBOX_API_KEY")?)?;

    // Create an identity and add a phone number.
    let identity = inkbox.create_identity("support-bot")?;
    identity.provision_phone_number("local", None)?;

    // Send email directly from the identity.
    identity.send_email(
        &["customer@example.com".into()],
        "Your order has shipped",
        Some("Tracking number: 1Z999AA10123456784"),
        None, None, None, None, None, false,
    )?;

    // Place an outbound call.
    identity.place_call(
        "+14155550123",
        CallOrigin::DedicatedNumber,
        Some("wss://my-app.com/voice"),
    )?;

    // Send a text.
    identity.send_text(
        Some(TextRecipients::One("+15551234567".into())),
        None,
        Some("Hi! This is your support bot."),
        None,
    )?;

    // Read inbox.
    for message in identity.iter_emails(None, None)? {
        println!("{:?}", message.subject);
    }

    // List calls.
    let calls = identity.list_calls(50, 0, None)?;
    println!("{} calls", calls.len());
    Ok(())
}

# Create an agent identity — provisions the mailbox and tunnel atomically.
inkbox identity create support-bot --display-name "Support Bot"

# Provision a phone number on the new identity.
inkbox number provision --handle support-bot

# Send email directly from the identity
inkbox email send -i support-bot \
--to customer@example.com \
--subject "Your order has shipped" \
--body-text "Tracking number: 1Z999AA10123456784"

# Place an outbound call
inkbox phone call -i support-bot \
--to +14155550123 \
--ws-url wss://my-app.com/voice

# Send a text
inkbox text send -i support-bot --to +15551234567 --text "Hi! This is your support bot."

# Read inbox
inkbox email list -i support-bot

# List calls
inkbox phone calls -i support-bot