ArchiWind
API
Guide

Guide

A simulation must belong to a project and use a model.

Flow to create a simulation (new project, new model) 

File ServerAPIClientFile ServerAPIClientPOST /archiwind/v1/projects1201 Created, returning $project_id2POST /archiwind/v1/models3201 Created, returning $model_id and each file's signed upload URL4Upload file #15Upload file #N6POST /archiwind/v1/models/${model_id}/finalise7200 OK8POST /archiwind/v1/simulations using $project_id and $model_id9201 Created10

Flow to create a simulation (existing project, new model) 

File ServerAPIClientFile ServerAPIClientGET /archiwind/v1/projects1200 OK, returning all projects with their $project_id2POST /archiwind/v1/models3201 Created, returning $model_id and each file's signed upload URL4Upload file #15Upload file #N6POST /archiwind/v1/models/${model_id}/finalise7200 OK8POST /archiwind/v1/simulations using $project_id and $model_id9201 Created10

Upload files to File Server

To upload a file to the File Server, you must issue an HTTP PUT request with the full file in the body and the header Content-Length matching its size.

Example:

curl -X PUT "$UPLOAD_URL" --upload-file /path/to/file.obj