Skip to content

Introduction

The Elaichi API is a JSON API over HTTPS. It covers what an integration needs: organizations, roles, teams, members, invites, domains, the audit log, connectors, connections, templates, toolboxes, synthetic tools, restrictions, access requests, logging and notification destinations, SSO and SCIM configuration, and files.

Use it to automate setup, keep Elaichi in sync with your own systems, or build internal tools on top of it.

Some actions need a person at a browser, so you do them in the app and not over the API. These are signing in, creating and revoking API tokens, creating and revoking SCIM tokens, setting up two-factor authentication, approving or rejecting an access request, and billing checkout. An API token cannot do these actions, and the API answers 403 if you try.
Base URL https://api.elaichi.ai
Auth Bearer token. See Authentication.
Format JSON requests and responses
OpenAPI GET /schema/openapi.yml

Make your first request

  1. In the app, open Settings → API tokens and create a token. See Create API tokens.
  2. Store the token in an environment variable named ELAICHI_API_TOKEN.
  3. List your connections:
curl https://api.elaichi.ai/connection \
  -H "Authorization: Bearer $ELAICHI_API_TOKEN"

The token works for the one organization in which you created it. You see the connections you may use in that organization.

How this reference is organized

The sidebar groups endpoints by resource, such as /connection, /toolbox, /template, /synthetic-tool, /access-request, /notification-destination, and /observability-destination. Open a resource to see its endpoints. Open an endpoint to see its parameters, request body, responses, and examples in curl, JavaScript, and Python.

The OpenAPI document describes the same set of endpoints. Use it to generate a client.

Next steps