Skip to content
Developer Portal

OpexMX API

Connect your entire operation. RESTful API with OpenAPI spec, MCP server for AI agents, and a TypeScript SDK. Build custom integrations, dashboards, and automations.

Quick Start

1

Generate an API Key

Go to Settings → API Keys in your OpexMX instance. Create a key with the scopes you need (read, write, or admin).

2

Make Your First Request

curl -H "Authorization: Bearer mx_your_key" https://<your-instance-domain>/api/rpc/assets

3

Explore the OpenAPI Spec

Every instance serves its OpenAPI spec at /api/openapi.json (Scalar UI at /api/openapi). Use the TypeScript SDK or generate a client in any language.

Sample Endpoints

MethodEndpoint
GET/api/v1/assets
GET/api/v1/work-orders
POST/api/v1/work-orders
GET/api/v1/inventory
POST/api/v1/tickets
GET/api/v1/technicians
GET/api/v1/analytics/mtbf
GET/api/v1/analytics/compliance

+ 30 more endpoints. Full OpenAPI 3.0 spec available.

MCP Server for AI Agents

Beyond REST, expose your entire OpexMX instance to AI agents via the Model Context Protocol — served over HTTP by every instance. 69 purpose-built tools for maintenance workflows.

Search assets by name, type, or location
Create and update work orders
Check parts inventory levels
List technician skills & availability
Get asset health scores
Generate compliance reports
Create maintenance tickets
Query PM schedules

Authentication

API Keys

Long-lived keys sent as a Bearer token. Generate from Settings → API Keys. Revoke anytime.

Permissions

A key carries the permissions of the user who created it. Create keys under a role with only the access your integration needs.

Rate Limits

600 requests per minute per API key by default; over the limit you get HTTP 429 with a Retry-After header. Webhook support for real-time events.

Ready to Build?

Request API access and start integrating OpexMX with your systems.

Request API Access