Project API
Manage projects within mindzieStudio tenants. Projects are the top-level containers for datasets, investigations, dashboards, and analysis workflows.
Features
Project Management
Create, retrieve, update, and delete projects. List all projects in a tenant with pagination support.
Cache Operations
Load projects into memory for fast access during API operations. Essential for executing notebooks and blocks efficiently.
User Permissions
Manage user access to projects. Add users, update permission levels (owner vs member), and remove access.
Import & Export
Export projects as portable .mpz files for backup or transfer. Import projects from .mpz files. Manage project thumbnails.
Available Endpoints
Connectivity Testing
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/{tenantId}/project/unauthorized-ping |
Public connectivity test |
| GET | /api/{tenantId}/project/ping |
Authenticated connectivity test |
Project CRUD
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/{tenantId}/project |
List all projects |
| GET | /api/{tenantId}/project/{projectId} |
Get project details |
| POST | /api/{tenantId}/project |
Create a project |
| PUT | /api/{tenantId}/project/{projectId} |
Update a project |
| DELETE | /api/{tenantId}/project/{projectId} |
Delete a project |
| GET | /api/{tenantId}/project/{projectId}/summary |
Get project statistics |
Cache Management
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/load |
Load project into cache |
| DELETE | /api/{tenantId}/project/{projectId}/unload |
Unload project from cache |
User Permissions
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/users |
List project users |
| POST | /api/{tenantId}/project/{projectId}/users/{userId} |
Add user to project |
| PUT | /api/{tenantId}/project/{projectId}/users/{userId} |
Update user permission |
| DELETE | /api/{tenantId}/project/{projectId}/users/{userId} |
Remove user |
Import/Export
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/download |
Export as .mpz |
| POST | /api/{tenantId}/project/import |
Import from .mpz |
Thumbnails
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/{tenantId}/project/{projectId}/thumbnail |
Get thumbnail |
| POST | /api/{tenantId}/project/{projectId}/thumbnail |
Update thumbnail |
| DELETE | /api/{tenantId}/project/{projectId}/thumbnail |
Remove thumbnail |
Authentication
All Project API endpoints require a valid API key. Use tenant-scoped API keys for project operations.
See Authentication for details on API key types and usage.
Quick Start
# List all projects in a tenant
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/project" \
-H "Authorization: Bearer YOUR_API_KEY"
# Load a project into cache before executing notebooks
curl -X GET "https://your-mindzie-instance.com/api/{tenantId}/project/{projectId}/load" \
-H "Authorization: Bearer YOUR_API_KEY"
Important Notes
- CASCADE Delete: Deleting a project permanently removes all datasets, investigations, dashboards, and files
- Cache Required: Load projects into cache before executing notebooks or blocks
- Cache Duration: Projects remain cached for 30 minutes after last access
- Export Before Delete: Always export projects before deletion as a backup