Projects

Create a new project

Changed on

Set 'visibility' to create a public or a private project. When omitted, users who can create private projects get a private project, all others (for example Community accounts) get a public one. Requesting a private project without a plan that allows it fails with 403.

post/projects

Request

  • Base URL
    https://api.simscale.com/v1
  • URL
    https://api.simscale.com/v1/projects
  • Auth
    API key in header X-API-KEY

Request body

projectIdstring
spaceIdstring uuid

Always returned by the backend. Optional at project creation. If missing, the project will be created in the Personal Space of the user.

parentFolderIdstring uuid

If missing, the project is located at the root level of the Space.

createdAtstring date-time
namestring required

The project title should contain the application you want to analyze as well as the simulation method you want to use, e.g. 'Heat exchanger - CHT simulation'.

descriptionstring

A meaningful description of the project.

measurementSystem'SI' | 'US_CUSTOMARY'

The measurement system of the project. Can't be modified. Only applies to SIMULATION projects, SI is used when it is omitted. PHYSICS_AI projects have no measurement system.

projectTypestring

The type of the project. Can only be set when the project is created, 'SIMULATION' is used when it is omitted. The possible values are 'SIMULATION' and 'PHYSICS_AI'.

visibility'PUBLIC' | 'PRIVATE'

Whether the project can be found, read and copied by anyone. Projects of Community accounts are always PUBLIC. Private projects require a Professional plan. When omitted at creation the plan default applies, when omitted on update the visibility is kept, and a copy is private on a Professional plan and has the visibility of the source project otherwise.

ownerUserIdstring

The userId of the user who owns the project.

tagsstring[]

Example request

{
  "projectId": "1234123412341234",
  "spaceId": "49eb49eb-49eb-49eb-49eb-49eb49eb49eb",
  "parentFolderId": "4e9c4e9c-4e9c-4e9c-4e9c-4e9c4e9c4e9c",
  "createdAt": "2020-01-01T01:00:00Z",
  "name": "My first project",
  "description": "My first project description",
  "measurementSystem": "SI",
  "visibility": "PUBLIC",
  "ownerUserId": "123456",
  "tags": [
    "FEA",
    "CFD"
  ]
}

Response

Successful creation of the project

projectIdstring
spaceIdstring uuid

Always returned by the backend. Optional at project creation. If missing, the project will be created in the Personal Space of the user.

parentFolderIdstring uuid

If missing, the project is located at the root level of the Space.

createdAtstring date-time
namestring required

The project title should contain the application you want to analyze as well as the simulation method you want to use, e.g. 'Heat exchanger - CHT simulation'.

descriptionstring

A meaningful description of the project.

measurementSystem'SI' | 'US_CUSTOMARY'

The measurement system of the project. Can't be modified. Only applies to SIMULATION projects, SI is used when it is omitted. PHYSICS_AI projects have no measurement system.

projectTypestring

The type of the project. Can only be set when the project is created, 'SIMULATION' is used when it is omitted. The possible values are 'SIMULATION' and 'PHYSICS_AI'.

visibility'PUBLIC' | 'PRIVATE'

Whether the project can be found, read and copied by anyone. Projects of Community accounts are always PUBLIC. Private projects require a Professional plan. When omitted at creation the plan default applies, when omitted on update the visibility is kept, and a copy is private on a Professional plan and has the visibility of the source project otherwise.

ownerUserIdstring

The userId of the user who owns the project.

tagsstring[]

Example response

{
  "projectId": "1234123412341234",
  "spaceId": "49eb49eb-49eb-49eb-49eb-49eb49eb49eb",
  "parentFolderId": "4e9c4e9c-4e9c-4e9c-4e9c-4e9c4e9c4e9c",
  "createdAt": "2020-01-01T01:00:00Z",
  "name": "My first project",
  "description": "My first project description",
  "measurementSystem": "SI",
  "visibility": "PUBLIC",
  "ownerUserId": "123456",
  "tags": [
    "FEA",
    "CFD"
  ]
}

Changes

    • info

      added the optional property to the response with the status

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status