CMF Endpoints

Simulation Creation

Post Cmf1

post
Authorizations
Body
mission_idstring · uuidRequired
take_offstring · date-timeRequired
battery_socnumber · max: 1Required
metadataany ofOptional
objectOptional
or
nullOptional
Responses
201
Successful Response
application/json
post
POST /check-my-flight/v1/cmf1 HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "battery_soc": 0.958,
  "metadata": {
    "custom_fields": "custom_values"
  },
  "mission_id": "9ff63e17-b9a7-42f2-af32-da27676c3a4d",
  "take_off": "2024-07-23T12:34:00Z"
}
{
  "simulation_id": "text"
}

Post Cmf2

post
Authorizations
Body
performance_set_idstring · uuidRequired
limit_set_idsstring · uuid[]Required
take_offstring · date-timeRequired
battery_socnumber · max: 1Required
metadataany ofOptional
objectOptional
or
nullOptional
Responses
201
Successful Response
application/json
post
POST /check-my-flight/v1/cmf2 HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 417

{
  "battery_soc": 0.958,
  "limit_set_ids": [
    "e60d72d0-d3ea-4222-bd64-6cfe3a19d2b6",
    "b338ab49-4094-4b16-b1f1-074636d77bee"
  ],
  "metadata": {
    "custom_fields": "custom_values"
  },
  "performance_set_id": "c5790525-5125-4f98-8fa5-ad7eeeaf924c",
  "route": [
    {
      "altitude": 100,
      "altitude_type": "AGL",
      "latitude": 52.52,
      "longitude": 13.404
    },
    {
      "altitude": 100,
      "altitude_type": "AGL",
      "latitude": 52.525,
      "longitude": 13.405
    }
  ],
  "take_off": "2024-07-23T12:34:00Z"
}
{
  "simulation_id": "text"
}

Post Cmf3

post
Authorizations
Body
take_offstring · date-timeRequired
battery_socnumber · max: 1Required
metadataany ofOptional
objectOptional
or
nullOptional
Responses
201
Successful Response
application/json
post
POST /check-my-flight/v1/cmf3 HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1200

{
  "battery_soc": 0.956,
  "limit_parameters": [
    {
      "altitude": 10,
      "altitude_type": "AGL",
      "altitude_unit": "m",
      "limits": [
        {
          "maxvalue": 5,
          "minvalue": 0,
          "sequence": 0,
          "type": "nominal"
        },
        {
          "maxvalue": 10,
          "minvalue": 5,
          "sequence": 1,
          "type": "moderate"
        },
        {
          "maxvalue": 15,
          "minvalue": 10,
          "sequence": 2,
          "type": "severe"
        }
      ],
      "name": "wind_speed_mean_1h",
      "type": "allmission",
      "unit": "m/s"
    },
    {
      "altitude": 10,
      "altitude_type": "AGL",
      "altitude_unit": "m",
      "limits": [
        {
          "maxvalue": 10,
          "minvalue": 0,
          "sequence": 0,
          "type": "nominal"
        },
        {
          "maxvalue": 20,
          "minvalue": 10,
          "sequence": 1,
          "type": "moderate"
        },
        {
          "maxvalue": 30,
          "minvalue": 20,
          "sequence": 2,
          "type": "severe"
        }
      ],
      "name": "wind_gust_1h",
      "type": "allmission",
      "unit": "m/s"
    }
  ],
  "metadata": {
    "test": "CMF Case 3"
  },
  "performance_parameters": [
    {
      "name": "cruise_speed",
      "type": "EAS",
      "unit": "m/s",
      "value": 30
    },
    {
      "name": "max_speed",
      "type": "EAS",
      "unit": "m/s",
      "value": 35
    },
    {
      "name": "rate_of_climb",
      "type": "TAS",
      "unit": "m/s",
      "value": 5
    },
    {
      "name": "rate_of_descent",
      "type": "TAS",
      "unit": "m/s",
      "value": 5
    },
    {
      "name": "endurance",
      "unit": "s",
      "value": 3600
    }
  ],
  "route": [
    {
      "altitude": 100,
      "altitude_type": "AGL",
      "latitude": 52.52,
      "longitude": 13.404
    },
    {
      "altitude": 100,
      "altitude_type": "AGL",
      "latitude": 52.521,
      "longitude": 13.405
    }
  ],
  "take_off": "2024-08-26T12:34:00+00:00"
}
{
  "simulation_id": "text"
}

Retrieve Results

Get Cmf

get
Authorizations
Path parameters
simulation_idstringRequired
Query parameters
extendedbooleanOptionalDefault: false
response_model_exclude_noneanyOptionalDefault: true
Responses
200
Successful Response
application/json
Responseany of
or
stringOptional
get
GET /check-my-flight/v1/cmf/{simulation_id} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "simulation_id": "text",
  "simulation_request_time": "2025-06-12T04:28:47.565Z",
  "flight_status": {
    "evaluation": "nominal",
    "reasons_moderate": [
      "text"
    ],
    "reasons_severe": [
      "text"
    ]
  },
  "route_distance": 1,
  "zero_wind_flight_time": 1,
  "take_off_time": "2025-06-12T04:28:47.565Z",
  "flight_time": 1,
  "landing_time": "2025-06-12T04:28:47.565Z",
  "soc_at_take_off_percent": 1,
  "soc_at_landing_percent": 1,
  "endurance_at_take_off": 1,
  "endurance_at_landing": 1,
  "elevation_at_take_off": 1,
  "elevation_at_landing": 1,
  "min_max_weather_parameters": [
    {
      "parameter": "text",
      "min": 1,
      "max": 1
    }
  ],
  "metadata": {},
  "segments": [
    {
      "latitude": 1,
      "longitude": 1,
      "altitude": 1,
      "timeframe": "text",
      "status": "nominal",
      "speed_gs": {
        "value": 1,
        "unit": "text"
      },
      "speed_eas": {
        "value": 1,
        "unit": "text"
      },
      "weather_parameter": [
        {
          "name": "text",
          "type": "text",
          "value": 1,
          "unit": "text",
          "status": "nominal"
        }
      ]
    }
  ]
}

PreviousCheck My Flight - CMFNextCMF Supporting Functions

Last updated

Was this helpful?