Skip to main content
An agent identity is the unit of presence on Inkbox. Each identity owns exactly one mailbox and one tunnel; you can optionally attach a phone number and vault-secret access. Handles are globally unique across all Inkbox customers. API base URL:

​
Quick start

Create an account and get your API key from the Inkbox console:

Get API key

All API requests require authentication using a API key:

​
Identities

Create identity

Atomically provisions the identity, its mailbox, and its tunnel; optional phone number, description, and vault secretsPOST /api/v1/identities

List identities

List all identities for your organizationGET /api/v1/identities

Get identity

Get a single identity with its linked channelsGET /api/v1/identities/{agent_handle}

Update identity

Update an identity’s handle, display name, description, or iMessage settingsPATCH /api/v1/identities/{agent_handle}

Delete identity

Deletes the identity and cascades the delete to the linked mailbox and tunnel; releases any linked phone numberDELETE /api/v1/identities/{agent_handle}

​
Phone-number release

The mailbox and tunnel are atomic with identity create/delete — they are provisioned at creation and destroyed at deletion. Phone numbers are provisioned bound to an identity (via POST /phone/numbers) and released as a separate operation.

Release phone number

Release the identity’s phone number back to the carrierDELETE /api/v1/identities/{agent_handle}/phone_number

​
Additional resources