Konso Public API

The Konso Public API provides programmatic access to Konso features and resources. All endpoints are secured and require authentication via an API key.

Overview

The Konso Public API allows you to programmatically interact with Konso’s core platform capabilities, including obeservability, headless content management, AI-powered content generation, automated agents, and platform integrations.

Use the API to integrate Konso into your backend services, CI/CD pipelines, internal tools, or custom applications. the most functionality exposed via the Konso dashboard is available through secure, versioned HTTP endpoints or gRPC calls.

What you can do with the API

With the Konso API you can:

Manage projects
Create, update, and deliver structured content
Fetch Business events, logs and mtrics
Integrate Konso into existing workflows and services

Who the API is for

The Konso Public API is designed for:

Backend and platform engineers
DevOps and automation workflows
SaaS integrations and internal tooling
Content pipelines powered by AI and automation

The API follows REST principles, uses predictable resource-oriented URLs, and exchanges data in JSON format.

Authentication

Konso uses API key–based authentication.

Every request must include the x-api-key header containing your personal API key.

REST

Request Header

x-api-key: <YOUR_API_KEY>

Example

GET /v1/cms/pages/{projectId}
Host: apis-spb.konso.io
x-api-key: <YOUR_API_KEY>

gRPC

Metadata

x-api-key: <YOUR_API_KEY>

🔒 Security note Keep your API key secret. Do not expose it in client-side code or public repositories.

Request / Response Format (http)

Konso Public API endpoints use JSON over HTTPS and return a consistent response envelope based on GenericResultResponse.

Common headers

All requests must include:

Accept: application/json`

For endpoints with a request body (POST, PUT), also include:

Content-Type: application/json

POST endpoints

Purpose: Create a new entity.

Request body

Each POST has a dedicated request DTO/class (e.g. CreateXRequest).
Detailed request information is presented in this reference.

Response model

{
  "result": true,
  "validationErrors": [],
  "errors": []
}

Status codes & behavior

201 Created — success
400 Bad Request — validation failure adds validation details to validationErrors
500 runtime failure adds error details to errors