SDK quickstart

pip install kardinal-ai

npm install @kardinal-ai/sdk

from kardinal import Kardinal
from kardinal.routing import examples

k = Kardinal()  # reads KARDINAL_API_KEY
plan = k.routing.plans.submit(examples.small_delivery_plan())
solution = k.routing.solutions.wait(plan.id)  # returns in about 20 seconds

import { Kardinal, examples } from "@kardinal-ai/sdk";

const k = new Kardinal(); // reads KARDINAL_API_KEY
const plan = await k.routing.plans.submit(examples.smallDeliveryPlan());
const solution = await k.routing.solutions.wait(plan.id); // resolves in about 20 seconds

print(solution.final_state)  # optimized, or interrupted/stopped if cut short
for tour in solution.tours or []:  # tours is None when no stop could be planned
    print(tour.resourceId, len(tour.wayPoints))

console.log(solution.finalState); // optimized, or interrupted/stopped if cut short
for (const tour of solution.tours ?? []) {
  // tours is absent when no stop could be planned
  console.log(tour.resourceId, tour.wayPoints?.length);
}