Kardinal

Kardinal Plan API

How to create, retrieve, update and delete plans.

GitHub OpenAPI
Business capability
Transport Operations Management BC-2420

Operations 12

GET /agencies/{agencyId}/plans Retrieves a collection of plans #
GET /agencies/{agencyId}/plans/{planId} Retrieve a plan #
PUT /agencies/{agencyId}/plans/{planId} Create or update a plan #
DELETE /agencies/{agencyId}/plans/{planId} Delete a plan #
PUT /agencies/{agencyId}/plans/{planId}/running Stop or restart the optimization of a plan #
GET /agencies/{agencyId}/plans/{planId}/solution Retrieve a plan solution #
GET /agencies/{agencyId}/plans/{planId}/solution/objectives Retrieve the objectives of a plan solution #
GET /agencies/{agencyId}/plans/{planId}/state Fetch the latest state of a plan #
GET /agencies/{agencyId}/plans/{planId}/states Fetch the latest states of a plan #
GET /agencies/{agencyId}/plans/{planId}/status Retrieve a plan status #
PUT /agencies/{agencyId}/plans/{planId}/mode Changes a plan's mode #
GET /agencies/{agencyId}/plans/{planId}/manual/check Check if a plan is in manual mode #

Documentation

📖
Documentation
https://developers.kardinal.ai/
📖
APIReference
https://developers.kardinal.ai/api-reference/authenticate/request-a-password-token
📖
GettingStarted
https://developers.kardinal.ai/getting-started/first-api-call
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/kardinal/refs/heads/main/authentication/kardinal-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/kardinal/refs/heads/main/openapi/kardinal-plan-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/kardinal/refs/heads/main/errors/kardinal-error-codes.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/kardinal/refs/heads/main/data-model/kardinal-data-model.yml
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/kardinal/refs/heads/main/mcp/kardinal-tool-crosswalk.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/kardinal-plan-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

kardinal-plan-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Kardinal ARO Plan API
  version: 2.55.0
  description: This document specifies the REST API of Kardinal ARO v2.
  contact:
    url: https://kardinal.ai/
    email: contact@kardinal.ai
servers:
- url: /api/v2
security:
- access_token: []
tags:


# --- truncated at 32 KB (121 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kardinal/refs/heads/main/openapi/kardinal-plan-api-openapi.yml