Skip to main content
The DeveloperAPI accepts two credentials. Either one alone is sufficient - do not send both on the same request (a Bearer token always wins if you do).

Where the credentials come from

  • API key - created on the API Keys page of the app at app.engini.io, for one workspace and one environment: see API keys. Sign in to the app however you like - email/password or OAuth (Google, Microsoft, GitHub) - then create a key. The CLI’s engini login opens this page for you when run interactively (a terminal on both stdin and stdout).
  • Bearer JWT - the session token Engini issues when you sign in (including via the OAuth providers above). It’s what the web app itself uses; you can pass it to the SDK (token=) or API for short-lived, user-scoped calls.
  • OAuth apps - third-party applications (and MCP clients) can obtain Engini Bearer tokens programmatically through the standard OAuth 2.1 authorization-code flow: see OAuth apps.
OAuth sign-in to Engini happens in the browser/web app - there is no OAuth device flow inside the CLI or SDK. For anything long-lived or headless, use an API key. (OAuth to third-party applications - Salesforce, Outlook, Gmail… - is a different flow and is fully supported programmatically: see Connections & OAuth.)

Base URL

Verify a credential

Returns the user, company, role, and caller type behind the credential. For an API key it also returns the workspace and environment the key is tied to. The SDKs expose this as client.auth.whoami(), the CLI as engini whoami.

In the SDKs

api_key/token/auth are mutually exclusive. With no explicit credential, the SDKs read ENGINI_API_KEY first, then ENGINI_API_TOKEN.

Failures

Missing or invalid credentials return 401; a valid credential without access to the resource returns 403. Both carry the standard error envelope.