How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kardinal Simple Plan API

How to create a plan through the use of a simple plan.

Kardinal Simple Plan API is one of 8 APIs that Kardinal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SimplePlan. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 1 operation across 1 path, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 2.55.0.

Requests are made against a single base URL, /api/v2.

1 operations 1 paths 27 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.55.0
Base URL
https://app.kardinal.ai/api/v2
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 5

Kardinal Simple Plan API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (otp_token). It accepts HTTP bearer tokens (JWT) (gdpr_token). It accepts HTTP bearer tokens (JWT) (access_token). It accepts HTTP bearer tokens (JWT) (refresh_token). It accepts HTTP bearer tokens (JWT) (password_token). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

SimplePlan 1

How to create a plan through the use of a simple plan.

POST
/agencies/{agencyId}/simplePlans
Create a simple plan
postSimplePlan 1 param body → 201400401403404500

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are SimplePlan (16 properties), SimpleResource (8 properties), SimpleStop (6 properties), EnvelopedSimplePlan (4 properties). Each schema is shown below with its type and property counts.

Capacities
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
AgencyId
The agency id.
ErrorProperties
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
SimplePlan
object
A simple plan is a simplified representation of a plan, with simplified resources, simplified stops, and a simplified objective.
16 properties 3 required
StopKind
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
PlanId
The plan id.
PlanState
string
The corresponding plan's state. - waiting: The plan was received and is awaiting processing. - processing: The plan is being processed. - preOptimizing: The pl…
Duration
string
A period of time, expressed in the ISO8601 duration format.
Position
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
2 properties 2 required
EnvelopedErrors
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
1 property
RegexPrefixedIdValidation
string
An id beginning with a prefix and an underscore.
SimpleObjective
string
[TOVALIDATE] Description pending review by a Kardinal engineer.
Break
[TOVALIDATE] Description pending review by a Kardinal engineer.
TimeWindowBreak
object
A required break of a given duration in a given time window.
3 properties 2 required
TravelDurationSlidingBreak
object
Limitation rule on max travel duration without any break.
3 properties 3 required
PlanVersion
integer
The plan version.
TimeZone
string
The time zone is a string code which identifies a region of the world in the "time zone database", also called "tz database". The tz database is a partition of…
AtFirstPositionArrival
string
The resource must go back to it's Tour first position.
SimpleStop
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
6 properties 2 required
UUID
string
Universally Unique Identifier.
DateTime
string
A full calendar date time, expressed in the ISO8601 date format: YYYY-MM-DDThh:mm:ssZ.
RegexIdValidation
string
At least one character among those allowed: unaccented alpha-numeric characters, "-", ".", "", "~", ":", "@", "!", "$", ",".
WorkingDurationSlidingBreak
object
Limitation rule on max working duration without any break.
3 properties 3 required
Error
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
3 properties 2 required
EnvelopedSimplePlan
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
4 properties
SimpleResource
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
8 properties 2 required
TimeWindow
object
[TOVALIDATE] Description pending review by a Kardinal engineer.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kardinal-simpleplan-api-openapi.yml Raw ↑

Other APIs Kardinal publishes across the network.

Kardinal Authenticate API
Kardinal Core API
Kardinal Management API
Kardinal Order API
Kardinal Plan API
Kardinal Resource API
Kardinal Solution API
Where this information came from

This is an independent, third-party profile of Kardinal Simple Plan API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.