Skip to content
ConnectPlane Developers

ConnectPlane API v1

Build reliable service workflows with stable contracts, generated clients, and clear integration guidance.
Explore the APIDownload OpenAPI

Start with the contract

Section titled “Start with the contract”

ConnectPlane publishes one reviewed API contract for people, SDK generators, and coding agents. Calls belong in server-side applications or secret-aware automation, never browser JavaScript.

Example server-side request
curl https://api.connectplane.com/api/v1/commerce/orders \
  -H "X-API-Key: ${CONNECTPLANE_API_KEY}"
Getting startedChoose the right endpoint, create a scoped key, and make a first request.
AuthenticationSend a scoped API key without exposing it in URLs, browsers, or logs.
VersioningUnderstand compatibility guarantees, deprecation, and independent release versions.
Errors and retriesHandle problem responses, request IDs, retryable failures, and conflicts.
SDKs and agentsUse generated clients, raw OpenAPI, Markdown guides, and llms.txt.
API referenceBrowse the complete, read-only ConnectPlane public API reference.

Machine-readable documentation

Section titled “Machine-readable documentation”

The OpenAPI document is the operation and schema authority. llms.txt provides a concise documentation index for coding agents. Both are public and contain no credentials.