v1.0.0

Quickstart

Run your first disruption recovery simulation in five minutes.

Prerequisites

  • A Pleiades API key (contact the team to obtain one)
  • curl, Python, or any HTTP client

Step 1: Verify connectivity

Check that the API is reachable:

bash
curl https://api.pleiadesaerospace.com/health

You should receive:

json
{
  "status": "healthy",
  "service": "Pleiades API",
  "timestamp": "2026-04-07T12:00:00+00:00",
  "version": "1.1.0"
}

Step 2: List available flights

Fetch flights to find a valid flight ID for your simulation:

bash
curl -H "X-API-Key: your-api-key" \
  "https://api.pleiadesaerospace.com/flights?airline=QF"

The response includes up to 50 flights with their IDs, tails, origins, destinations, and times.

Step 3: Run a simulation

Pick a flight ID from the previous response and submit a disruption scenario:

bash
curl -X POST https://api.pleiadesaerospace.com/simulate \
  -H "X-API-Key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "scenario_id": "quickstart-001",
    "disrupted_flight": "QF401_2026-04-07T08:30:00Z",
    "min_delay_minutes": 120,
    "airline": "QF"
  }'

Step 4: Interpret the results

The response contains an array of options, each representing a recovery strategy. Key fields:

FieldWhat it tells you
options[].summary.otpOn-time performance after recovery (0–1)
options[].summary.npsPassenger satisfaction proxy (0–1)
options[].summary.costWeighted cost in solver units
options[].action_setSpecific actions: delays, swaps, cancellations
best_option_idThe solver's recommended option
violationsAny maintenance or crew duty violations detected

You're ready

You've successfully run your first simulation. Explore the full Simulation endpoint reference for custom configurations, or learn how to tune the solver.

Next steps