Checking on Simulation Status

Once your simulation has been confirmed, it enters the execution queue. You can monitor its progress by polling the API. This allows you to track the simulation as it moves through the PREPARING, RUNNING, and COMPLETED stages.

Step 3: Getting the Simulation Status

To check the status of a simulation, you make a GET request to the /v1/weather-simulation endpoint, passing the simulationRequestId as a query parameter.

This is the same uuid you received when you first created the simulation plan.

For full technical details, see the API Reference.

Example Request

Here is an example of how to fetch the status of our running simulation.


curl -X GET 'https://api.weatherwise.fr/v1/weather-simulation?simulationRequestId=6a7b9d0c-1234-4f8a-9b10-2d3e4f5a6b7c' \
--header 'X-API-KEY: YOUR_API_KEY'

Understanding the Status Response

The response will be the full simulation request object, updated with the current status of each nested run. You can poll this endpoint periodically to track the progress.

Example Response (Run in Progress)

While the simulation is executing, the status of a run will be PREPARING or RUNNING.


{
  "uuid": "6a7b9d0c-1234-4f8a-9b10-2d3e4f5a6b7c",
  // ... other fields
  "runs": [
    {
      "uuid": "f755904f-f614-4912-97d8-cbfffc53010b",
      "resolution": {
        "x": 5000.0,
        "y": 5000.0,
        "unit": "M"
      },
      "model": "MESONH",
      "status": "RUNNING"
    },
    {
      "uuid": "1675ba77-0075-4e7c-a568-c530b96311fe",
      "resolution": {
        "x": 1000.0,
        "y": 1000.0,
        "unit": "M"
      },
      "model": "MESONH",
      "status": "RUNNING"
    },
    {
      "uuid": "a29b1b13-7b83-46ec-8051-5163f9686713",
      "resolution": {
        "x": 250.0,
        "y": 250.0,
        "unit": "M"
      },
      "model": "MESONH",
      "status": "RUNNING"
    }
  ]
}

Example Response (Run Completed)

Once a run is finished, its status will change to COMPLETED. At this point, a new field, downloadUrl, will appear within that run’s object. This signals that the data is ready for retrieval.


{
  "uuid": "6a7b9d0c-1234-4f8a-9b10-2d3e4f5a6b7c",
  // ... other fields
  "runs": [
    {
      "uuid": "f755904f-f614-4912-97d8-cbfffc53010b",
      "resolution": {
        "x": 5000.0,
        "y": 5000.0,
        "unit": "M"
      },
      "model": "MESONH",
      "status": "COMPLETED",
      "downloadUrl": "https://s3.amazonaws.com/.../run-8e0627e7.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
    },
    {
      "uuid": "1675ba77-0075-4e7c-a568-c530b96311fe",
      "resolution": {
        "x": 1000.0,
        "y": 1000.0,
        "unit": "M"
      },
      "model": "MESONH",
      "status": "COMPLETED",
      "downloadUrl": "https://s3.amazonaws.com/.../run-1c3450c3.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
    },
    {
      "uuid": "a29b1b13-7b83-46ec-8051-5163f9686713",
      "resolution": {
        "x": 250.0,
        "y": 250.0,
        "unit": "M"
      },
      "model": "MESONH",
      "status": "COMPLETED",
      "downloadUrl": "https://s3.amazonaws.com/.../run-4a3521b5.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=..."
    }
  ]
}

Next Steps

Once the downloadUrl is present, you can proceed to the final step.

Downloading simulation outputs: Learn how to use the download link and understand the structure of the output data.