Skip to main content

​
Base URL

​
Authentication

Send one of:
  • x-api-key: eng_... - Developer API key (recommended; bound to your account)
  • Authorization: Bearer <jwt> - Engini-issued JWT
Don’t send both - Bearer wins. Verify a credential with GET /v1/auth/whoami. Full details: Authentication.

​
Pagination

List endpoints take offset (default 0) and top (default 100; connections list 25) and return:
Page until offset + items.length >= totalCount. Full contract: Pagination, errors & rate limits.

​
Errors

Every non-200 response uses one envelope:
400 validation failures carry field-level details. On 429, honor the Retry-After header (seconds).

​
Tool execution semantics

POST /v1/tools/{toolSlug}/execute is the one endpoint where HTTP 200 does not mean success: tool-runtime failures return 200 with isSuccess: false + errorMessage. Branch on isSuccess. The executing connection resolves in this order: explicit ?connectionId= → the ?toolsetId=’s connection for the tool’s application → your per-application default → otherwise 409 NO_DEFAULT_CONNECTION. Details: Platform model.

​
Identifiers

Applications and tools are identified by slugs (monday, monday_create_item); connections by integer ids; toolsets by GUIDs. JSON is camelCase throughout.