REST API Reference
Public REST API for programmatic read access to Metapad models. All endpoints require an API token (mpt_...) or OAuth JWT. Pro+ plan required.
/api/v1/models/{model_id}RESTGet Model
Returns the full model data including metamodel (M2 types) and all node/relationship instances. Equivalent to a full JSON export.
/api/v1/models/{model_id}/relationshipsRESTList Relationships
Paginated list of relationships with filtering by type, source, or target node. Returns x-total-count header for pagination.
/api/v1/models/{model_id}/exportRESTExport Model
Export the full model as a downloadable JSON file. Identical payload to Get Model but served with Content-Disposition: attachment for direct download.
/api/v1/models/{model_id}/metadataRESTGet Metadata
Lightweight model metadata: name, description, language list, node/relationship counts, and last updated timestamp. Does not return model content.
/api/v1/models/{model_id}/foldersRESTList Folders
Returns the complete folder hierarchy for the model. Folders are optional organizational containers for nodes.
/api/v1/models/{model_id}/nodes/batchRESTBatch 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).
/api/v1/models/{model_id}/nodes/{node_id}RESTGet 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).
/api/v1/models/{model_id}/nodesRESTList 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.
/api/v1/models/{model_id}/schemaRESTGet Schema
Returns the metamodel (M2 schema): all node types, relationship types, their properties, and allowed connection patterns. Equivalent to the MCP get_metamodel tool.