Authentication

All requests to the Arreteq API must be authenticated using a Bearer token. Generate API keys from your organisation settings in the Arreteq platform.

Authorization: Bearer <your-api-key>
Content-Type: application/json

Base URL

https://api.arreteq.com

All API requests are served over HTTPS. HTTP requests will be redirected to HTTPS. Rate limiting applies per API key — contact us for enterprise rate limit increases.

Endpoints

Below is a summary of the available API endpoints. Full request/response schemas and examples are available in our interactive documentation (coming soon).

Method	Path	Description
GET	/v1/processes	List all processes in a workspace
POST	/v1/processes	Create a new process
GET	/v1/processes/{id}	Retrieve a specific process
PUT	/v1/processes/{id}	Update a process
DELETE	/v1/processes/{id}	Archive a process
GET	/v1/workspaces	List accessible workspaces
GET	/v1/users	List users in your organisation
GET	/v1/capabilities	List business capabilities
POST	/v1/diagrams/generate	Generate a BPMN diagram from text
GET	/v1/compliance/controls	List compliance controls
POST	/v1/compliance/evidence	Submit compliance evidence
GET	/v1/roadmap/initiatives	List roadmap initiatives

Example Request

curl -X GET https://api.arreteq.com/v1/processes \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspace_id": "ws_abc123", "limit": 20}'

{
  "data": [
    {
      "id": "proc_xyz789",
      "name": "Customer Onboarding",
      "status": "published",
      "version": 3,
      "updated_at": "2026-03-12T10:30:00Z"
    }
  ],
  "meta": {
    "total": 142,
    "page": 1,
    "limit": 20
  }
}

Client Libraries

Official SDK libraries for popular languages are in development. Subscribe to our developer newsletter for early access.

🟨 JavaScript / Node.js Coming soon

🐍 Python Coming soon

☕ Java Coming soon

🔷 .NET / C# Coming soon

MCP Server

Arreteq exposes an MCP (Model Context Protocol) server endpoint allowing AI agents and LLMs to query your knowledge base, process repository, and architecture models in real time. This is the recommended integration path for AI-native workflows.

https://mcp.arreteq.com/{your-org-slug}/sse

API Reference