Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ntropii.com/llms.txt

Use this file to discover all available pages before exploring further.

Every interaction with Ntropii Workspace — every CLI command, every MCP tool call, every SDK method — authenticates with an API key.

How keys are scoped

API keys are tenant-scoped. One key gives access to exactly one tenant; if you administer three tenants, you’ll have three keys. The organisation that owns the tenant is recorded as provenance, but it is not an authorisation boundary. This matters because:
  • A leaked key compromises one tenant’s surface area, not your whole organisation.
  • Different teams within an organisation can hold different keys for different tenants without seeing each other’s runs.
  • Rotation is per-tenant — you can rotate a key without disturbing other tenants.

Generate a key

ntro auth login
Walks you through:
1

Pick a connection name

Used in ~/.ntro/config.toml as [connections.<name>]. local, staging, and production are conventional. You can have as many as you like.
2

Enter the host

https://api.ntropii.com/v1 for production.
3

Paste the API key

You generate the key in the Ntropii web UI under Settings → API keys. The CLI does not mint keys directly.
4

Pick a default tenant

Most CLI commands target a tenant. Setting a default at login skips having to pass --tenant on every call. Override with -c connection, --tenant slug, or NTRO_TENANT.
Verify the key works:
ntro auth whoami
# → identity, organisation, accessible tenants
For non-interactive setups (CI/CD pipelines, headless installs), pass everything as flags:
ntro auth login --no-interactive \
  --name production \
  --host https://api.ntropii.com/v1 \
  --api-key ntro_prod_abc123 \
  --default-tenant acme-fund-admin

Where the key gets used

The same key works across all three surfaces:
Picked up automatically from ~/.ntro/config.toml based on the active connection. Override with --host + NTRO_API_KEY.
ntro -c production tenant list

Rotation

# 1. Mint a new key in the Ntropii web UI
# 2. Update the relevant connection
ntro auth login --name production
#    (overwrite when prompted; old key stays valid until you revoke it in the UI)

# 3. Revoke the old key in the UI
Because keys are tenant-scoped, rotation is a per-tenant operation. There is no concept of an organisation-wide rotation that revokes everything.
Don’t commit API keys to a runbook git repo. The repo is what gets uploaded to Ntropii Tenant on deploy — anything in the source tree ends up readable by your worker logs. Always read the key from ~/.ntro/config.toml (the SDK does this for you) or from a secrets manager at runtime.

What’s next

Ntro CLI reference

Discover each command, flag, and example to use on Ntropii.

Wire MCP into your coding agent

Give Claude Code or Copilot Studio access to Ntropii.