Skip to main content

Resources

Every inbox resource below is generated from the same OpenAPI spec documented in the API Reference — the CLI dispatches to the exact same endpoints, so filters, upsert matching, validation and soft-delete behave identically. Reach for schema introspection whenever a command's exact parameters aren't obvious from the examples here.

kobana inbox <resource> <method> [flags]

How to read these pages​

Each command line follows:

kobana inbox workspaces get --params '{"id": "WORKSPACE_ID"}'

  • --params carries query and path parameters (id, page, filters).
  • --json carries the request body, for create/upsert/update.
  • --fields limits which fields come back, worth using on every list/get to save context.

See Global flags for the full flag reference and Authentication for the inbox product's own JWT + mTLS requirements.

The catalogue​

ResourceCommands
Workspaceslist, get, create, upsert, update, delete
Inboxeslist, get, create, upsert, update, delete, recipients create/delete
E-mailslist, get, eml, reprocess, delete
Agentslist, get, create, upsert, update, delete, versions list, models list
Agent runs and usageagent-runs list/get, usage summary/cost
Webhookslist, get, create, upsert, update, delete, test, regenerate-secret, deliveries list/get/replay
System eventslist, get
Secretslist, get, create, upsert, update, delete
Workflow runslist, get