API FAQs

This FAQ page acts as a quick reference to the common questions and resources when using the Rescale API. Please find the complete and extended version of the API Documentation here.

These fields go into the data file (cURL) or script (python) in the process of creating a job. Please refer to the tutorial here or the complete API Documentation.

FieldDefaultRequiredDescription
nameNoneYesHuman friendly name for this job.
paramFileNoneNoFile with parameter variables.
caseFileNoneNoFile with case variables.
jobvariablesNoneNoList of job variables for this job. See details in section below.
jobanalysesNoneYesList of analyses for this job. See details in section below.
resourceFiltersDefault filtersNoList of filtering rules for output files.
isTemplateDryRunFalseNoRun this job in “dry run” mode.
includeNominalRunFalseNoInclude the run with nominal variables.
monteCarloIterationsNoneNoNumber of iterations in case the variables use a monteCarlo generator type.

You can get the full list of codes and options by calling curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/analyses/

Here are the codes of the more common softwares:

AnalysisCode
Abaqusabaqus
COMSOLcomsol
CONVERGEconverge_open_mpi
OpenFOAMopenfoam
STAR-CCM+cd_adapco_star_ccm
XFlowxflow

Note: Don’t forget to include the field "useRescaleLicense":true if you are purchasing on demand licenses for your software through Rescale.

You can get the full list of codes and options by calling curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/coretypes/.

Here are the codes of the more common core types:

Core TypeCode
Emeraldhpc-3
Nickelhpc-plus
Marblestandard-plus
Obsidianobsidian
Titaniumtitanium
Ironhpc-infiniband