Model API Overview

Introduction

The Matterport Model API lets developers search, read, and change model data programmatically. It provides access to model details such as the name and address of a space, sharing URLs, images, videos, panoramic imagery, position points, and Tags. Purchased assets — including the OBJ mesh and point cloud files within a MatterPak — are also accessible once unlocked.

The Model API is available to users at all account levels.

Access Requirements

You must have:

• An active Matterport account
• API credentials (Token ID and Token Secret) generated through your Matterport Cloud account

Accounts have only Sandbox mode enabled by default. For more information, see the Developer Tools Availability and Pricing article.

GraphQL Endpoint

https://api.matterport.com/api/models/graph

You can also explore the schema interactively in the Model API GraphiQL console.

Getting Started

• Browse common request patterns on the Model API Queries page
• View end-to-end Samples
• Use Postman to explore the API interactively
• Learn about Views & Layers and GeoCoordinates

Schema Reference

For a complete reference of all available mutations and queries, see the Model API Schema Reference.