# Modelry

Modelry is a 3D visualization platform for eCommerce that creates custom 3D product models, AR experiences, and digital asset management.

- **Category:** ecommerce
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 15
- **Triggers:** 0
- **Slug:** `MODELRY`
- **Version:** 20260223_00

## Tools

### Create Workspace

**Slug:** `MODELRY_CREATE_WORKSPACE`

Create a new workspace or return an existing one with the same name. Workspaces are used to organize products and embeds in Modelry. If workspace creation is not supported by the API, this tool will return an existing workspace matching the requested name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Human-readable name for the workspace. If a workspace with this name already exists, it will be returned instead of creating a duplicate. |
| `description` | string | No | Optional description or purpose of the workspace. Note: The Modelry API may not support setting descriptions during creation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Modelry Embed

**Slug:** `MODELRY_DELETE_EMBED`

Tool to delete an embed. Tries multiple common endpoint patterns and treats 404 as idempotent success after exhausting candidates (embed already deleted or not found).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embedId` | string | Yes | ID of the embed to delete |
| `workspaceId` | string | No | Optional workspace scope to try workspace-scoped deletion endpoints as well. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Modelry Product

**Slug:** `MODELRY_DELETE_PRODUCT`

Permanently deletes a product from Modelry by its ID. Use this action to remove a product that is no longer needed. This operation is idempotent - deleting an already-deleted product will succeed without error. Prerequisites: - Obtain the product ID using MODELRY_LIST_PRODUCTS first - Ensure you have delete permissions for the product WARNING: This action is destructive and cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `productId` | string | Yes | The unique identifier of the product to delete. Obtain this ID from MODELRY_LIST_PRODUCTS. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Product Repository

**Slug:** `MODELRY_DELETE_PRODUCT_REPOSITORY`

Permanently delete a product repository from Modelry. This action is idempotent - deleting a non-existent repository returns success. Use the list product repositories action first to get valid repository IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `repositoryId` | string | Yes | The unique identifier of the product repository to delete. Can be obtained from the list product repositories action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Modelry Workspace

**Slug:** `MODELRY_DELETE_WORKSPACE`

Permanently deletes a Modelry workspace. This action is idempotent - deleting a non-existent workspace will return success. Use the list workspaces action first to get valid workspace IDs. WARNING: This is a destructive action that cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspaceId` | string | Yes | The unique identifier of the workspace to delete. Can be obtained from the list workspaces action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Embed

**Slug:** `MODELRY_GET_EMBED`

Retrieve details of a specific Modelry embed (3D viewer or AR experience for eCommerce). Use MODELRY_LIST_EMBEDS first to obtain valid embed IDs. Returns embed metadata including status, workspace, and configuration details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `embed_id` | string | Yes | Unique identifier of the Modelry embed (3D viewer/AR experience) to retrieve. Obtain valid IDs from MODELRY_LIST_EMBEDS first. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace

**Slug:** `MODELRY_GET_WORKSPACE`

Retrieves details for a specific Modelry workspace by its ID or name. The workspace ID can be obtained from the List Workspaces action. This action fetches all workspaces and returns the matching one.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | The unique identifier (ID) or name of the workspace to retrieve. Get this from the List Workspaces action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Embeds

**Slug:** `MODELRY_LIST_EMBEDS`

List embeds in Modelry. Embeds are 3D viewer/AR embed codes for products. Use to retrieve embed IDs for downstream actions (e.g., MODELRY_GET_EMBED, MODELRY_DELETE_EMBED). Returns empty list if no embeds exist. Supports pagination and optional workspace filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination, must be >= 1 |
| `per_page` | integer | No | Number of items per page for pagination, between 1 and 100 |
| `workspace_id` | string | No | Optional workspace identifier to scope the embeds listing |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Modeling Requests

**Slug:** `MODELRY_LIST_MODELING_REQUESTS`

List all 3D modeling requests in a workspace. Requires workspace_id to scope the request. Returns modeling requests with their status and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (starts at 1) |
| `per_page` | integer | No | Number of items per page (1-100) |
| `workspace_id` | string | Yes | Unique identifier of the workspace to list modeling requests for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Product Repositories

**Slug:** `MODELRY_LIST_PRODUCT_REPOSITORIES`

Tool to list all product repositories in a workspace. Use after confirming the workspace ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Unique identifier of the workspace to list repositories for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Modelry Products

**Slug:** `MODELRY_LIST_PRODUCTS`

List all products in Modelry. Returns paginated product data including IDs, names, and metadata. Use this to retrieve product IDs needed for other product-related actions like delete or get details. Optionally scope to a specific workspace using workspace_id parameter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination, must be >= 1 |
| `per_page` | integer | No | Number of items per page for pagination, between 1 and 100 |
| `workspace_id` | string | No | Workspace ID to scope the products listing. If provided, only products in this workspace are returned. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Modelry Workspaces

**Slug:** `MODELRY_LIST_WORKSPACES`

Tool to list all workspaces in Modelry. Use when you need to retrieve available workspaces after authenticating.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination, must be >= 1 |
| `per_page` | integer | No | Number of items per page for pagination, between 1 and 100 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Order Modeling Service

**Slug:** `MODELRY_ORDER_MODELING_SERVICE`

Tool to place an order for 3D modeling services. Use when workspace and product IDs are known and modeling specifications are ready.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `notes` | string | No | Additional instructions or comments for the modeler |
| `due_date` | string | No | Requested delivery date in ISO 8601 format; if omitted, standard turnaround applies |
| `priority` | string ("standard" | "rush") | No | Turnaround priority; 'rush' may incur extra fees |
| `product_id` | string | Yes | Identifier of the product to be modeled |
| `service_type` | string ("basic" | "advanced" | "photo-realistic") | Yes | Level of modeling detail required |
| `workspace_id` | string | Yes | Unique identifier of the workspace where the order is placed |
| `reference_images` | array | No | List of URLs pointing to reference images for the modeler |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Track Modeling Progress

**Slug:** `MODELRY_TRACK_MODELING_PROGRESS`

Tool to track the progress of a 3D modeling request. Use after initiating a modeling job to poll current status and completion percentage.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | string | Yes | Unique identifier of the modeling request to track |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
