REST-API-Referenz

HTTP-Endpunkte für den programmatischen Zugriff auf Metapad-Modelle und -Daten.

ℹ️
This is the HTTP REST API for direct programmatic access. For AI-native access via Claude Desktop or Claude Code, see the MCP API Reference.
POST
/api/v1/models/{model_id}/nodes/batchPro+

Batch Get Nodes

Fetch multiple nodes by ID in a single request. More efficient than multiple single-node calls. Accepts UUIDs and auto-IDs (e.g. REQ-42).

GET
/api/v1/models/{model_id}/exportPro+

Export Model

Export the full model as a downloadable JSON file. Identical payload to Get Model but served with Content-Disposition: attachment for direct download.

GET
/api/v1/models/{model_id}/metadataPro+

Get Metadata

Lightweight model metadata: name, description, language list, node/relationship counts, and last updated timestamp. Does not return model content.

GET
/api/v1/models/{model_id}Pro+

Get Model

Returns the full model data including metamodel (M2 types) and all node/relationship instances. Equivalent to a full JSON export.

GET
/api/v1/models/{model_id}/nodes/{node_id}Pro+

Get Node

Full details for a single node including all properties and optionally its incoming and outgoing relationships. Accepts UUID or auto-ID (e.g. REQ-42).

GET
/api/v1/models/{model_id}/schemaPro+

Get Schema

Returns the metamodel (M2 schema): all node types, relationship types, their properties, and allowed connection patterns. Equivalent to the MCP get_metamodel tool.

GET
/api/v1/models/{model_id}/foldersPro+

List Folders

Returns the complete folder hierarchy for the model. Folders are optional organizational containers for nodes.

GET
/api/v1/models/{model_id}/nodesPro+

List Nodes

Paginated list of node instances with filtering by type, folder, and full-text search. Returns a page of node summaries plus x-total-count header for pagination.

GET
/api/v1/models/{model_id}/relationshipsPro+

List Relationships

Paginated list of relationships with filtering by type, source, or target node. Returns x-total-count header for pagination.