Skip to main content

​
List Projects

Returns all projects, optionally filtered by status. 
curl -X GET http://localhost:8080/api/projects

​
Query Parameters

​
status
string
Filter by project status: active, archived, or draft

​
Response

​
projects
array
Array of project objects

​
Create Project

Creates a new project. 
curl -X POST http://localhost:8080/api/projects \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Manufacturing Analytics",
    "description": "IoT sensor analytics for manufacturing",
    "version": "1.0",
    "status": "active",
    "tags": ["manufacturing", "iot"],
    "settings": {
      "timezone": "UTC",
      "environment": "production"
    }
  }'

​
Request Body

​
name
string
required
Project name
​
description
string
Project description
​
version
string
Project version (defaults to “1.0”)
​
status
string
Project status: active, archived, or draft (defaults to draft)
​
tags
array
Array of tag strings
​
settings
object
Project settings
​
components
object
Component associations (empty by default)

​
Response

Returns the created project object (see List Projects for schema).

​
Clone Project

Deep-clones an existing project including all its pipelines, ontologies, ML models, digital twins, and storage configurations. 
curl -X POST http://localhost:8080/api/projects/clone \
  -H "Content-Type: application/json" \
  -d '{
    "source_project_id": "proj-123",
    "name": "Manufacturing Analytics - Dev"
  }'

​
Request Body

​
source_project_id
string
required
ID of the project to clone
​
name
string
required
Name for the cloned project

​
Response

Returns the cloned project object with new IDs for all cloned components.

​
Get Project

Returns a single project by ID. 
curl -X GET http://localhost:8080/api/projects/proj-123

​
Path Parameters

​
id
string
required
Project ID

​
Response

Returns the project object (see List Projects for schema).

​
Update Project

Updates a project’s name, description, or status. 
curl -X PUT http://localhost:8080/api/projects/proj-123 \
  -H "Content-Type: application/json" \
  -d '{
    "description": "Updated description",
    "status": "active"
  }'

​
Path Parameters

​
id
string
required
Project ID

​
Request Body

All fields are optional. Only provided fields will be updated.
​
description
string
New description
​
version
string
New version
​
status
string
New status: active, archived, or draft
​
settings
object
Updated settings
​
tags
array
Updated tags array

​
Response

Returns the updated project object.

​
Delete Project

Deletes a project and all its components. 
curl -X DELETE http://localhost:8080/api/projects/proj-123

​
Path Parameters

​
id
string
required
Project ID

​
Response

Returns 204 No Content on success.

​
Add Component to Project

Associates a pipeline, ontology, ML model, digital twin, or storage config with a project. 
curl -X POST http://localhost:8080/api/projects/proj-123/pipelines/pipe-456

​
Path Parameters

​
id
string
required
Project ID
​
componentType
string
required
Component type: pipelines, ontologies, mlmodels, digitaltwins, or storage
​
componentId
string
required
Component ID to associate

​
Response

Returns 204 No Content on success.

​
Remove Component from Project

Removes the association between a component and a project. 
curl -X DELETE http://localhost:8080/api/projects/proj-123/pipelines/pipe-456

​
Path Parameters

​
id
string
required
Project ID
​
componentType
string
required
Component type: pipelines, ontologies, mlmodels, digitaltwins, or storage
​
componentId
string
required
Component ID to disassociate

​
Response

Returns 204 No Content on success.

Build docs developers (and LLMs) love

Get started for freeTalk to us