Public REST API · v1.0

Knowmax Developer API

Build smarter support experiences by integrating Knowmax's knowledge management platform directly into your products. Retrieve articles, FAQs, decision trees, AI-powered answers, and more — all through a single, consistent REST API.

REST over HTTPS JSON responses API Key auth 4 global regions 26 endpoints 1,500 req/min

Authentication

Pass your channel API key in the x-api-key header on every request. Each channel has its own key — find it under Admin → Org Settings → Channels. The key controls which content is returned.

Tenant Subdomain

Your tenant name is the path segment in your Knowmax URL. For in-next.knowmax.ai/acme/home, the subdomain value is acme. Pass it as a header on every request.

Multi-Region

Use the region selector above to get the correct base URL. Your region (IN, ME, EU, US) is determined when your Knowmax instance is provisioned.

Authentication

Every API request must carry a valid x-api-key header. Requests with a missing or invalid key receive a 403 Forbidden response. API keys in Knowmax are channel-scoped — each channel has its own unique key, and you choose which channel's key to use depending on what content you need to expose.

What is a Channel?
A Channel is Knowmax's content access layer. When content is published in your knowledge base, it can be mapped to one or more channels. When you make an API request using a channel's key, only content mapped to that channel will be returned — any content not associated with that channel is excluded from the response.

Example: If your knowledge base has 30 articles and 20 are mapped to the Customer Portal channel, the API key for that channel will return only those 20 articles. The remaining 10 are invisible to that key. This lets you serve different audiences or integrations from a single knowledge base without duplicating content.

Where to find your API key: Log in to the Knowmax Admin Panel → Org Settings → Channels → select the channel you want to integrate with → copy the API key shown for that channel.

cURL example

GET https://in-manage.knowmax.ai/api/v1/articles # Required on every request — use the API key of the channel you want to query x-api-key: your_channel_api_key subdomain: your_tenant_name Content-Type: application/json

Regions & Base URL

The base URL is region-specific. Select your region in the header above to auto-populate example URLs throughout this reference. Your region is fixed at the time your Knowmax instance is provisioned.

Active Base URL

https://in-manage.knowmax.ai

Region	Code	Base URL	Client Portal URL Pattern
India	`IN`	`https://in-manage.knowmax.ai`	`https://in-next.knowmax.ai/{tenant}/home`
Middle East	`ME`	`https://me-manage.knowmax.ai`	`https://me-next.knowmax.ai/{tenant}/home`
Europe	`EU`	`https://eu-manage.knowmax.ai`	`https://eu-next.knowmax.ai/{tenant}/home`
United States	`US`	`https://us-manage.knowmax.ai`	`https://us-next.knowmax.ai/{tenant}/home`

Common Headers

These headers apply to all or most endpoints. Always include x-api-key and subdomain.

Header	Required	Description
`x-api-key`	Yes	Your channel API key. Each channel in Knowmax has its own key — the key you use determines which subset of content is returned. Find it in Admin → Org Settings → Channels → <select channel>.
`subdomain`	Yes	Your client tenant name - the path segment in your Knowmax portal URL. Example: from `https://in-next.knowmax.ai/acme/home` the value is `acme`
`language`	No	Language ID for localized content — not a language code. Call `GET /api/v1/languages` to get the list of IDs enabled for your tenant, then pass the `id` field value here.
`Content-Type`	POST only	Must be `application/json` for all POST requests with a body

Session tracking: Endpoints that support session tracking require a sessionId obtained from the corresponding POST /{id}/session endpoint. Create a session first, then pass its ID in subsequent calls to enable analytics and interaction history.

Rate Limit: The API is throttled at 1,500 requests per minute per API key. Requests exceeding this limit will receive a 429 Too Many Requests response. Implement exponential back-off in your integration to handle this gracefully.