Skip to main content
The CLI’s engini connect <app> wraps this whole page in one guided (and agent-resumable) command - see CLI commands. Use the SDK when you need the flow inside your own product.

Discover how an application connects

Every application lists its authentication methods - each with an authentication_id, a field list, and whether it’s OAuth:

Direct-credential connections (API keys, DB credentials…)

The OAuth flow

Three steps: get a sign-in URL, let the user authorize in a browser, then poll for the captured token and create the connection from it.
Build the create fields from the token’s connectionData only - tokenData is the raw OAuth token (access_token, token_type…) and the API rejects unknown connector fields. While the sign-in is pending, get_access_token returns an empty body - treat that as “keep polling”, not an error.

Refresh & object selection

Applications with supports_object_selection expose objects (tables, entities) to choose from. Refresh is asynchronous - trigger it, then poll:
select_objects replaces the whole selection set. A completed refresh also proves the connection authenticates - it’s a stronger health signal than check (which can be inconclusive). A refresh that doesn’t finish in time raises EnginiTimeoutError.

Defaults

The default connection is what implicit tool execution resolves to: