API reference
This page lists every HTTP endpoint your account can call on this instance, including the endpoints of installed plugins. Nothing in the list is written by hand: Chetty reads it from the routes it serves right now. When an administrator installs, updates or turns off a plugin, the list follows, and an endpoint your account may not call never appears.
What this reference shows
- Endpoints are grouped by owner: Chetty core first, then each plugin under its name with the description the plugin declares.
- Every endpoint shows its method, its path and the one sentence the endpoint itself declares about when to use it.
- The search above the list finds endpoints by words or by meaning. It is the same search Chetty uses when it looks for an endpoint in a conversation.
Summaries and field descriptions come from the endpoints themselves, so they are in English.
Read an endpoint
Open an endpoint to see what it accepts:
- Path parameters, Query parameters and Request body list the fields the endpoint validates, each with its type and whether it is required.
- A badge marks a plugin endpoint that only administrators may call, and the kind of answer it gives when it is not plain JSON.
- A badge also says when the endpoint is not available with a personal API token or to the agent. Those are actions that need you signed in to the web app.
A core endpoint checks administrator rights itself, so it can still answer 403 for an account that is not an administrator. The open endpoint says so.
Use an example
Each endpoint you can reach from a script comes with a curl command and the same call for the ElowenApi tool, built from the endpoint's own fields. The examples fill in only the required fields; replace every value in angle brackets, such as <id>, with your own.
The curl command uses the ELOWEN_URL and ELOWEN_TOKEN variables from Send your first agent API request. You create the token as described in Create and manage a personal API token. Every path goes to the same host under /api.
Call it from an agent or a tool
- In a conversation, Chetty calls endpoints through its
ElowenApitool. The tool searches and describes this same catalog, and the example shows the arguments it sends. - From an MCP client, the
elowen_requesttool takes the same method, path and body; see Use Chetty as an MCP server. - From the terminal app,
elowen apitakes the method, the path and an optional JSON body; see Run the CLI from scripts. - From your own client, read the catalog behind this page: it is itself an endpoint of Chetty core. Search the list for
api-catalog.
Plugin authors who want their plugin to use another plugin's connection, such as the Microsoft 365 sign-in of Microsoft Teams, follow the plugin-author guide Connecting plugins.
Endpoints
The list below is loaded for your account each time you open this page.