NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Matterport connects to a Nagent workspace. Once it is connected, agents can call 6 Matterport actions, such as "Get Model by ID", "Get Model Event Webhook Callbacks" and "List Room Classifications". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Matterport, with input parameters and output schema.
MATTERPORT_DELETE_MODELTool to permanently delete a Matterport model. Use when you need to remove a model entirely from the Matterport platform. This operation is irreversible.
Input parameters
Unique identifier of the Matterport model to be permanently deleted
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MATTERPORT_MODELTool to retrieve detailed information about a single Matterport 3D model by its ID. Use when you need to fetch model metadata, publication details, spatial information, or other properties of a specific Matterport model.
Input parameters
Unique identifier of the Matterport model to retrieve
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MATTERPORT_MODEL_EVENT_WEBHOOK_CALLBACKSTool to retrieve a list of registered webhook callback configurations for model events. Use when you need to view all configured webhooks that receive notifications when model events occur (e.g., created, deleted, updated, processed, transferred).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MATTERPORT_MODELSTool to retrieve a page of Matterport models with optional search and filtering. Use when you need to list, search, or filter models within an organization.
Input parameters
Free text search string for models. Use '*' for all models, or provide specific search terms. If unspecified, all models within the organization are returned
Offset ID for pagination. Use the 'nextOffset' value from a previous response to retrieve the next page of results
Determines result ordering. Valid values: 'created' (creation timestamp), 'modified' (modification timestamp), 'name' (alphabetical). Defaults to creation timestamp descending if not specified
Include additional models in non-active states. Valid values: 'demo' (include demo models), 'inactive' (include archived models)
Maximum number of results per page. Maximum allowed is 1000, default is 10
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MATTERPORT_ROOM_CLASSIFICATIONSTool to list all room classifications defined for Matterport room classification models. Use when you need to retrieve the available room types and their associated keywords.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
MATTERPORT_UPDATE_MODEL_STATETool to change a Matterport model between active and inactive (archived) states. Use when you need to archive an inactive model or unarchive an active model. This operation is idempotent.
Input parameters
The model identifier to modify
Specifies which ID field to use for lookup. Valid values: 'id' (primary identifier), 'internalId' (internal system identifier), 'mlsId' (MLS identifier). Defaults to primary identifier if not specified
Target state for the model. Use 'active' to unarchive the model or 'inactive' to archive the model
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 6 Matterport actions on Nagent, including "Get Model by ID", "Get Model Event Webhook Callbacks" and "List Room Classifications". Get Model by ID: Retrieve detailed information about a single Matterport 3D model by its ID. Each action is listed on this page with its input parameters and its output.
Get Model by ID takes 1 required input: modelId. It returns data, error and successful.