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}/assets/{asset_id}/filePro+

Ressourcendatei anhängen

Hängt eine Datei an eine bereits bestehende Ressource oder ersetzt sie. Die Ressource behält ihre ID, sodass eine asset:-Referenz, die bereits in einer Beschreibung oder auf einer veröffentlichten Seite steht, gültig bleibt — genau deshalb ist dies der richtige Weg, ein aktualisiertes Bild erneut zu veröffentlichen.

→
POST
/api/v1/models/{model_id}/nodes/batchPro+

Knoten stapelweise abrufen

Mehrere Knoten per ID in einer einzigen Anfrage abrufen. Effizienter als mehrere Einzelknoten-Aufrufe. Akzeptiert UUIDs und Auto-IDs (z. B. REQ-42).

→
DELETE
/api/v1/models/{model_id}/assets/{asset_id}/filePro+

Ressourcendatei löschen

Löst die Datei von einer Ressource. Das Ressourcen-Element selbst bleibt im Modell erhalten — nur die angehängte Datei wird aus dem Objektspeicher entfernt und die Dateimetadaten werden geleert.

→
GET
/api/v1/models/{model_id}/assets/{asset_id}/downloadPro+

Ressource herunterladen

Lädt die an eine Ressource angehängte Datei herunter. Gibt eine 302-Weiterleitung auf eine kurzlebige, vorsignierte S3-URL zurück — Clients müssen Weiterleitungen folgen, um die Datei abzurufen. Gibt 404 mit dem Code „nofile“ zurück, wenn die Ressource keine Datei hat.

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

Modell exportieren

Das vollständige Modell als herunterladbare JSON-Datei exportieren. Identische Daten wie bei „Modell abrufen", aber mit Content-Disposition: attachment für direkten Download.

→
GET
/api/v1/models/{model_id}/assets/{asset_id}Pro+

Ressourcen-Metadaten abrufen

Ruft die Metadaten einer einzelnen Ressource ab (Bezeichnung, Beschreibung, Dateiname, Inhaltstyp, Größe, Tags, Zeitstempel). Gibt die Datei selbst nicht zurück — nutzen Sie dafür „Ressource herunterladen“.

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

Metadaten abrufen

Leichtgewichtige Modell-Metadaten: Name, Beschreibung, Sprachliste, Knoten-/Beziehungsanzahlen und Zeitstempel der letzten Aktualisierung. Gibt keine Modellinhalte zurück.

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

Modell abrufen

Gibt die vollständigen Modelldaten einschließlich Metamodell (M2-Typen) und aller Knoten-/Beziehungsinstanzen zurück. Entspricht einem vollständigen JSON-Export.

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

Knoten abrufen

Vollständige Details für einen einzelnen Knoten einschließlich aller Eigenschaften und optional seiner ein- und ausgehenden Beziehungen. Akzeptiert UUID oder Auto-ID (z. B. REQ-42).

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

Schema abrufen

Gibt das Metamodell (M2-Schema) zurück: alle Knotentypen, Beziehungstypen, deren Eigenschaften und erlaubte Verbindungsmuster. Entspricht dem MCP-Tool getmetamodel.

→
GET
/api/v1/models/{model_id}/assetsPro+

Ressourcen auflisten

Listet alle Ressourcen (Dateianhänge) eines Modells auf. Gibt nur Metadaten zurück — die Dateien selbst werden separat über „Ressource herunterladen“ abgerufen. Nützlich, um zu sehen, was an einem Modell hängt.

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

Ordner auflisten

Gibt die vollständige Ordnerhierarchie für das Modell zurück. Ordner sind optionale Organisationscontainer für Knoten.

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

Knoten auflisten

Paginierte Liste von Knoteninstanzen mit Filterung nach Typ, Ordner und Volltextsuche. Gibt eine Seite mit Knotenzusammenfassungen plus x-total-count-Header für die Paginierung zurück.

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

Beziehungen auflisten

Paginierte Liste von Beziehungen mit Filterung nach Typ, Quell- oder Zielknoten. Gibt x-total-count-Header für die Paginierung zurück.

→
POST
/mcp/{model_id}Pro+

MCP-Tool-Aufruf

Der MCP-HTTP-Transport. Ein einziger JSON-RPC-2.0-Endpunkt, der alle MCP-Tools von Metapad bedient (getmetamodel, searchnodes, createnodes usw.) — setzen Sie „method“ auf die JSON-RPC-Methode („tools/call“, „tools/list“, „initialize“, „ping“) und geben Sie den Tool-Namen samt Argumenten in „params“ an. Es ist derselbe Endpunkt, mit dem sich Claude Desktop, Claude Code und andere MCP-Clients verbinden — nutzen Sie ihn direkt aus Skripten und CI, wenn kein interaktiver OAuth-Login möglich ist. Zu unterscheiden von den REST-API-v1-Endpunkten unter /api/v1/..., die einzelne Ressourcen klassisch als REST bereitstellen.

→
POST
/api/v1/models/{model_id}/assetsPro+

Ressource hochladen

Legt eine neue Ressource in einem Modell an und hängt in einem einzigen Multipart-Upload eine Datei an. Sendet die Kollaborations-Operationen AssetAdded und AssetFileAttached — Nutzerinnen und Nutzer im Browser sehen die neue Ressource in Echtzeit. Maximal 100 MB.

→

Dieser Inhalt wurde kollaborativ mit KI erstellt.