When using the API, the generic steps you should follow are as follows. Note the relevant
API calls are shown and linked between the brackets ( ).
- Create a project (/projects/create) – This defines information about the simulation you will run and can conceptually group together similar simulation cases.
- Upload files (/files/getUploadSignedUrl) – Upload a zip file containing information for your simulation case.
- Create a case (/cases/create/{projectId}) – This defines the simulation details, such as CPU configuration, and associates the simulation files from the previous step with the simulation case.
- Run the simulation case (/caseRun/runCase/{caseId}).
- Wait for the simulation to complete (/caseRun/caseStatus/{caseId}) – This involves periodic polling to the API.
- Download the results of the simulation (/files/getDownloadSignedUrl/byCaseFilesId/{caseId}) – This is done via secure signed URLs.
- Optionally delete the case and/or project (/projects/delete/{projectId} or /cases/delete/{caseId}) – If you do not delete your simulation data, Kaleidosim will remove this data after 60 days automatically.