REST-API-Referenz

Öffentliche REST-API für programmatischen Lesezugriff auf Metapad-Modelle. Alle Endpunkte erfordern ein API-Token (mpt_...) oder OAuth-JWT. Pro+-Plan erforderlich.

GET
/api/v1/models/{model_id}/assetsREST

List Assets

List all assets (file attachments) in a model. Returns metadata only — file binaries are fetched separately via Download Asset. Useful for browsing what's attached to a model.

GET
/api/v1/models/{model_id}/assets/{asset_id}REST

Get Asset Metadata

Fetch metadata for a single asset (label, description, filename, content type, size, tags, timestamps). Does not return the file binary — use Download Asset for that.

GET
/api/v1/models/{model_id}/assets/{asset_id}/downloadREST

Download Asset

Download the file attached to an asset. Returns a 302 redirect to a short-lived presigned S3 URL — clients must follow redirects to fetch the binary. Returns 404 with code 'no_file' if the asset has no file attached.

DELETE
/api/v1/models/{model_id}/assets/{asset_id}/fileREST

Delete Asset File

Detach the file from an asset. The asset element itself stays in the model — only the attached binary is removed from object storage and the file metadata cleared. Use this to replace a file (delete, then upload).

POST
/api/v1/models/{model_id}/assetsREST

Upload Asset

Create a new asset in a model and attach a file in a single multipart upload. Broadcasts AssetAdded + AssetFileAttached collaboration operations — browser users see the new asset in real-time. 100 MB max.

GET
/api/v1/models/{model_id}REST

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}/relationshipsREST

Beziehungen auflisten

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

GET
/api/v1/models/{model_id}/exportREST

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}/metadataREST

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}/foldersREST

Ordner auflisten

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

POST
/api/v1/models/{model_id}/nodes/batchREST

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).

GET
/api/v1/models/{model_id}/nodes/{node_id}REST

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}/nodesREST

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}/schemaREST

Schema abrufen

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