Skip to main content

1. Get an API key

Create a Developer API key on your Engini account’s keys page. Keys are prefixed eng_ and are sent in the x-api-key header - the key is bound to your account server-side, so it’s the only credential you need.
Never commit API keys. Export them as environment variables: ENGINI_API_KEY.

2. Install

3. Verify your key

4. Discover applications and tools

5. Connect an application

Tools execute through a connection - your authenticated link to the application. The fastest way to create one is the CLI’s guided flow (it handles credentials, OAuth, and object selection):
Or do it programmatically - see Connections & OAuth.

6. Execute a tool

A 200 response does not mean the tool succeeded - always check isSuccess. Tool-runtime failures (e.g. the downstream API rejected the call) return 200 with isSuccess: false and an errorMessage; every other failure uses the standard error envelope.

Next steps

Connections & OAuth

Create connections programmatically, run the OAuth flow, select objects.

Give tools to an LLM

Toolsets + OpenAI/Anthropic providers - the agent loop.

CLI machine contract

Exit codes, JSON output, --schema, result handles.

For AI Agents

How agents should discover and operate Engini.