Jamdesk Documentation logo

Knowledge API

Search your Jamdesk documentation programmatically with the Knowledge API. Power support chatbots, Slack bots, custom search, and AI agents with accurate, up-to-date answers from your docs.

The Knowledge API gives you programmatic access to your documentation content via semantic search. One endpoint — POST /_knowledge/search — takes a natural language query and returns the most relevant passages from your docs, ranked by relevance.

Use Cases

Support Chatbots

Connect Intercom Fin, Zendesk AI, or a custom chatbot to your docs so it answers questions with accurate, cited content.

Slack Bots

Build a /docs Slack command that searches your documentation and posts the top results to any channel.

Custom Search

Add a search interface to your product, dashboard, or internal tools that surfaces relevant docs in context.

AI Agents

Give AI agents like Claude or GPT a tool that retrieves up-to-date documentation, not stale training data.

Quick Start

1
Generate an API key

Go to Project Settings → API Keys in the Jamdesk dashboard. Click Generate Key, give it a name, and copy the key — it starts with jdk_ and is only shown once.

2
Make your first search request

Send a POST request to /_knowledge/search on your docs subdomain:

curl -X POST https://your-project.jamdesk.app/_knowledge/search \
  -H "Authorization: Bearer jdk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I set up a custom domain?", "limit": 5}'
3
Use the results

The response returns an array of matching passages with relevance scores and page metadata:

{
  "query": "How do I set up a custom domain?",
  "results": [
    {
      "score": 0.94,
      "text": "To add a custom domain, go to Project Settings → Custom Domain...",
      "page": {
        "title": "Custom Domains",
        "path": "/deploy/custom-domains",
        "url": "https://your-project.jamdesk.app/deploy/custom-domains"
      }
    }
  ],
  "total": 1
}

Authentication

All requests require a Bearer token in the Authorization header.

Authorization: Bearer jdk_your_key_here

Generating API Keys

1
Open Project Settings

In the Jamdesk dashboard, navigate to your project and click Settings.

2
Go to API Keys

Select the API Keys tab.

3
Create a key

Click Generate Key, enter a descriptive name (e.g. "Intercom chatbot"), and click Create.

4
Copy the key

Copy the key immediately — it starts with jdk_ and is shown only once. Store it in your secrets manager or environment variables.

Key Management

API keys are scoped to a single project. A key for acme.jamdesk.app cannot query a different project's documentation.

RuleDetail
PrefixAll keys start with jdk_
ScopeOne key per project — cannot access other projects
RotationRevoke and regenerate anytime from Project Settings
StorageStore in environment variables or a secrets manager — never commit to source control

Revoking Keys

To revoke a key, go to Project Settings → API Keys, find the key by name, and click Revoke. Revoked keys stop working immediately. Generate a new key to replace it.

Rate Limits

Requests are rate-limited per API key.

PlanLimit
Pro60 requests / minute
EnterpriseCustom — contact support

When you exceed the limit, the API returns 429 Too Many Requests with a Retry-After header indicating how many seconds to wait.

If you need higher rate limits for a production integration, contact us to discuss Enterprise options.

Next Steps

Search Endpoint

Full reference with request/response schemas and interactive playground

Integration Guides

Step-by-step guides for Intercom, Zendesk, Slack bots, and custom chatbots