Skip to main content

Introduction

kobana is a single command-line tool for every Kobana product's API — the Autonomous Inbox included. It is built and maintained in its own repository (kobana-cli), not by this product, and it does not hardcode endpoints: at startup it parses the OpenAPI 3.1 specs embedded in the binary and builds its command tree from them. Updating the API surface is a matter of refreshing the embedded spec and shipping a new build — no per-endpoint code.

kobana <product> <resource> <method> [flags]

Designed for both humans and AI agents: structured JSON output by default, schema introspection, --dry-run and automatic pagination.

Products​

ProductDescriptionStatus
bankingGateway Bancário — charges, payments, transfers (API v1 and v2)Available
inboxAutonomous Inbox — inboxes, agents, e-mails, webhooks (this API)Available
financeFinanceiro Inteligente — payables and receivables, transactions, cash flowAvailable
billingFaturamento Automático — subscriptions, plans, invoices, tax documentsAvailable

The inbox product talks to the same API documented on this site. Its resources — workspaces, inboxes, emails, agents, agent-runs, webhooks, system-events — map directly onto the Models and Resources in the API Reference; the CLI is just another way to call it. It does not share credentials or transport with banking: see Authentication.

Getting started​

  1. Install it — see Installation.

  2. Authenticate for the product you need — a Bearer token for inbox, OAuth or a token for banking. See Authentication.

  3. Make your first call:

    kobana inbox workspaces list --fields "id,name"

  4. Explore the surface — every command supports --help, and kobana schema introspects any endpoint's parameters and body without leaving the terminal.

Next steps​