Note: This article is technical, so we recommend involving someone with the right technical expertise. If you have any questions, contact us at support@azumuta.com.
Our REST API uses standard HTTP response codes and verbs. When making a normal GET-request, the data is returned as JSON-encoded responses.
Authentication
The Azumuta API uses API keys to authenticate requests. You have two options:
Header (recommended)
Send the key in the X-API-Key request header.
Parameter
Use the apiKey query parameter.
Create and manage keys under Management → Devices → API. See Create and manage API keys.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Note: Your API keys are sensitive information that should never be shared with anyone outside of your company, and must never appear in browser client code.
Access API documentation
The Azumuta REST API is documented in our in-app API docs:
- Click the question mark on the top right of your screen (Help).
- Click API docs.
That opens the interactive reference at /docs/api in the Azumuta platform. There you can browse endpoints for Azumuta modules and add-ons (except Dashboards).
When you are authenticated, you can live-test endpoints with the Try it out button and see the result in your Azumuta platform.
Workspace AI Primer for Developers
If you are building an integration with an AI coding assistant, start with the workspace-tailored primer rather than pasting the full OpenAPI document into your knowledge base.
Authenticated GET /api/v1/agents-azumuta.md returns a markdown file for your workspace that includes base URL, languages, and API conventions. Download it from the in-app API docs introduction, or request that path with your API key.
The machine-readable OpenAPI spec is available at /api/v1/spec.json and also requires your API key, or via the Swagger UI in the API docs.
MCP for AI assistants (BETA)
BETA: Azumuta MCP is currently in beta and may still evolve. It is available by opt-in only. To join the beta or ask questions, contact support@azumuta.com.
Model Context Protocol (MCP) lets your preferred AI assistant retrieve permitted workspace data through selected read-only tools. It does not expose every REST operation. Follow Connect your AI assistant to Azumuta for setup, then see Use Azumuta MCP for examples and limitations.
Call the API from Server-Side Integrations
Call the Azumuta REST API from server-side integrations only. Hold the API key on your server or integration layer - not in operator browsers or other client-side code.