Alomana API documentation
The Alomana API serves the same endpoints as the Alomana web app, so a script or coding agent can do with an API key what a user does in the browser.
Client app
Your interface
Alomana Agent
Reason, retrieve, act
connections
Connected apps
Knowledge base
Files, documents, and searchable content
Start here
- Get started: make your first call with an API key.
- Authentication and API keys: choose a key and send it.
- Run an agent and stream its events: get an agent's answer.
- Set up a client: create an organization, a workspace, roles and members with one platform key.
Concepts
| Concept | What it is |
|---|---|
| Workspace | The boundary for data, agents, connections, members and usage. Selected on each request with X-Space-Slug. |
| Organization | An optional group of workspaces that share custom roles and role changes. |
| Agent | A reusable resource built from a model, prompts, tools, skills, Files scopes and connections. |
| Connectors and Files | Credential-managed access to external systems, and searchable workspace knowledge. |