Skip to content
AlumiaDocs

Search docs

Find pages, headings, and concepts. Press ⌘K or Ctrl+K to toggle.

API access

Use Alumia agents and platform resources from your own application.

Open in ChatGPTOpen in Claude

API access lets you invoke agents and platform workflows from your own application. Generate API keys from /<orgSlug>/developers → API Keys.

bash
Sign in to fill in your org and key
curl https://alumia.com/api/v1/agents \
-H "Authorization: Bearer alm_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Scopes and rate limits

Dashboard-minted keys default to models:read. Additional org API scopes include terminal (CLI device login) and billing:machine:charge (machine payments, owner/admin only). A subset of REST routes enforce these scopes — see Authentication.

Hosted MCP at https://app.alumia.com/mcp uses a separate MCP-layer read / write check on each tool. Prefer alumia mcp --stdio with a normal API key for local automation — see Connect via MCP.

CLI device login (alumia login --device) and API key minting share token-bucket limits keyed on user + IP. Exceeding limits returns 429 with Retry-After.

API reference index

Full route docs: API overview — schedules, tasks, knowledge, datasets, domains, telephony, skills, notifications, workspaces, shop, recovery, agent wallet, and more.

What you can build

  • Trigger an agent from an external workflow.
  • Create sessions and send messages.
  • Read project and canvas state where your key has access.
  • Connect Alumia to internal tools through your backend.

Keep API keys server-side. Do not place them in browser bundles, mobile apps, public repositories, or user-visible configuration.

The org is derived from the key — you do not send a separate org header. Some mutations (workspace changes, project sharing, org membership, account-security changes, webhook/MCP/domain administration, and privileged agent restrictions) require the dashboard with step-up and reject API keys; see Authentication.

For terminal automation, use the @hasna/alumia CLI (alumia login --device) or MCP stdio server — see Terminal CLI and Connect via MCP.