model-api-server

Provide RESTful read and write access to ArchiMate models via HTTP requests.

Updated Feb 14, 2026
One-click install
npx skills add https://github.com/ThomasRohde/jarchi-scripting-system --skill model-api-server
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: model-api-server
Source: https://github.com/ThomasRohde/jarchi-scripting-system/tree/main/.claude/skills/model-api-server
Command: npx skills add https://github.com/ThomasRohde/jarchi-scripting-system --skill model-api-server

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides a powerful REST API to programmatically interact with ArchiMate models, enabling automation of complex model operations, data integration, and AI-driven model manipulation.

Core Features & Use Cases

  • Model Querying & Searching: Retrieve model snapshots, statistics, and search elements/relationships by various criteria.
  • Model Mutations (Plan/Apply): Perform bulk create, update, and delete operations on model elements and relationships using an atomic, undoable transaction system.
  • View Management: Create, export, duplicate, and apply layouts to ArchiMate views.
  • Script Execution: Run JArchi scripts directly via the API for custom logic.
  • Use Case: Automatically generate a set of ArchiMate elements and relationships based on an external data source, or export all diagrams in a model as PNG images.

Quick Start

Use the model-api-server skill to get the health status of the API server.

Frequently Asked Questions about model-api-server

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate ArchiMate model manipulation using an API?

You can automate ArchiMate model manipulation using a RESTful API that supports read and write operations over HTTP. This enables automated model generation, data synchronization, and AI-assisted model engineering by sending HTTP requests to an active API server instance.

What is the best way to programmatically query and search Archi models?

The best way to programmatically query Archi models is via REST API endpoints that retrieve model snapshots, statistics, and search elements by various criteria. This allows external scripts and automation tools to access ArchiMate data without manual GUI interaction.

Can I execute JArchi scripts directly through an HTTP request?

Yes, you can execute JArchi scripts directly through the REST API to run custom logic. This feature enables remote script execution for automated model engineering and complex data transformations within an open Archi model.

Does the REST API support atomic transactions for bulk model updates?

Yes, the REST API supports atomic, undoable transactions for bulk model updates. You can perform create, update, and delete operations on model elements and relationships using a plan and apply transaction system to ensure data integrity.

Do I need an open Archi model to use the model API server?

Yes, you must have an open Archi model and an active API server instance running. The API provides programmatic access to the currently open model, meaning the Archi application must be operational to handle incoming HTTP requests.