SymetryML Documentation
Projects

Create new project

Creates a new project of the given `type`. The request body carries any type-specific build parameters as a flat string-keyed object (e.g. `partitionSplit`/`sml_project_order` for `partition`/`sequence` projects); it can be omitted or empty for simple types like `cpu`. Fails with a conflict if a project with this name already exists for the customer.

POST
/{user}/projects

Creates a new project of the given type. The request body carries any type-specific build parameters as a flat string-keyed object (e.g. partitionSplit/sml_project_order for partition/sequence projects); it can be omitted or empty for simple types like cpu. Fails with a conflict if a project with this name already exists for the customer.

Authorization

SymetryMLAuth
AuthorizationBearer <token>

HMAC-SHA256 signature-based authentication: requests are signed with your secret key and sent with the Customer-ID, Sym-date, Authorization, Content-MD5 and sym-version headers. See SymetryML REST API Security for the signature algorithm and a complete example.

In: header

Path Parameters

user*string

User/Customer identifier

Query Parameters

pid*string

Project identifier

type?string

Project type - cpu (default), gpu for GPU acceleration, mgpuf/mgpud for multi-GPU variants, sequence for time series, partition for partitioned data, fed for a federated project, dynamic is an alias for cpu. Fusion projects are NOT created via this endpoint — use the dedicated fusion/create endpoint instead.

Default"cpu"

Value in

  • "cpu"
  • "gpu"
  • "mgpuf"
  • "mgpud"
  • "sequence"
  • "partition"
  • "fed"
  • "dynamic"
persist?boolean

Whether to persist project data to disk

Defaulttrue
enableHistogram?boolean

Enable histogram tracking for data distributions

Defaultfalse
histogramType?string

Type of histogram to use

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

A flat Map<String, String> of type-specific build parameters.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/c1/projects?pid=nbra_prj_iris&type=cpu&persist=true" \  -H "Content-Type: application/json" \  -d '{    "partitionSplit": "class",    "sml_project_order": "1"  }'
{  "statusCode": 201,  "statusString": "Project Created with id:myProject",  "values": {}}
{  "statusCode": 400,  "statusString": "Invalid sequence project order: 0; it must be an integer greater than 0",  "values": {}}
{  "statusCode": 409,  "statusString": "Customer [c1] already have pid with id[myProject], ",  "values": {}}
{  "statusCode": 500,  "statusString": "Generic Exception [java.lang.Exception: warm_up_period:1000 needs to be greater than num_centroid:1000]",  "values": {}}

List all projects GET

Returns the names of all projects currently known for this customer. Unlike `GET /{user}/projects/info`, this call is always synchronous — it never returns a job to poll.

Delete project DELETE

Permanently deletes the project and its persisted state. Fails if no project with this name exists for the customer.