Integrationen

Diese Anleitung zeigt, wie Sie die Docs Search API mit den gängigsten Tools verbinden: Intercom, Zendesk, Slack und eigenen Chatbots.

Intercom (Fin AI Agent)

Intercoms Fin AI Agent unterstützt Data Connectors: externe Suchquellen, die Fin neben Ihren Intercom-Artikeln abfragt. Verbinden Sie die Docs Search API, damit Fin Fragen direkt aus Ihrer Jamdesk-Dokumentation beantworten kann.

---

Zendesk (MCP Server)

Die AI-Funktionen von Zendesk unterstützen MCP-Server als Wissensquellen. Verwenden Sie den integrierten MCP-Server von Jamdesk, um Ihre Dokumentation ohne benutzerdefinierten Code mit den AI-Agenten von Zendesk zu verbinden.

---

Eigene Chatbots

Fügen Sie jedem Chatbot oder jeder Webanwendung mit einem standardmäßigen fetch-Aufruf die Dokumentationssuche hinzu. CORS ist aktiviert, sodass browserbasierte Clients die API direkt ohne Backend-Proxy aufrufen können.

async function searchDocs(query) {
  const response = await fetch(
    "https://your-project.jamdesk.app/_api/search",
    {
      method: "POST",
      headers: {
        "Authorization": "Bearer jd_live_c83003a54ae0a83123454c3f7ec82f0a",
        "Content-Type": "application/json",
      },
      body: JSON.stringify({ query, limit: 5 }),
    }
  );

  if (!response.ok) {
    const { error } = await response.json();
    throw new Error(error);
  }

  const data = await response.json();
  return data.results;
}

// Example usage
const results = await searchDocs("How do I configure a custom domain?");

results.forEach((result) => {
  console.log(`[${result.score.toFixed(2)}] ${result.title}`);
  console.log(result.content);
  console.log(result.url);
  console.log("---");
});

Tool für einen AI-Agenten erstellen

Übergeben Sie Suchergebnisse als Kontext an ein Sprachmodell, um fundierte Antworten zu generieren:

import Anthropic from "@anthropic-ai/sdk";

const client = new Anthropic();

async function answerFromDocs(userQuestion) {
  // 1. Search your docs
  const results = await searchDocs(userQuestion);
  const context = results
    .map((r) => `[${r.title}](${r.url})\n${r.content}`)
    .join("\n\n---\n\n");

  // 2. Pass context to Claude
  const message = await client.messages.create({
    model: "claude-sonnet-4-5-20241022",
    max_tokens: 1024,
    messages: [
      {
        role: "user",
        content: `Answer the following question using only the provided documentation excerpts.
If the answer isn't in the docs, say so.

Documentation:
${context}

Question: ${userQuestion}`,
      },
    ],
  });

  return message.content[0].text;
}

---

Slack-Bots

Erstellen Sie einen Slack-Slash-Befehl /docs, der Ihre Dokumentation durchsucht und Ergebnisse in jedem Channel veröffentlicht.

import { App } from "@slack/bolt";

const app = new App({
  token: process.env.SLACK_BOT_TOKEN,
  signingSecret: process.env.SLACK_SIGNING_SECRET,
});

app.command("/docs", async ({ command, ack, respond }) => {
  await ack();

  const query = command.text.trim();
  if (!query) {
    await respond("Usage: `/docs <your question>`");
    return;
  }

  try {
    const response = await fetch(
      "https://your-project.jamdesk.app/_api/search",
      {
        method: "POST",
        headers: {
          "Authorization": `Bearer ${process.env.JAMDESK_API_KEY}`,
          "Content-Type": "application/json",
        },
        body: JSON.stringify({ query, limit: 3 }),
      }
    );

    const data = await response.json();

    if (data.results.length === 0) {
      await respond(`No results found for: _${query}_`);
      return;
    }

    const blocks = [
      {
        type: "section",
        text: {
          type: "mrkdwn",
          text: `*Results for:* _${query}_`,
        },
      },
      { type: "divider" },
      ...data.results.flatMap((result) => [
        {
          type: "section",
          text: {
            type: "mrkdwn",
            text: `*<${result.url}|${result.title}>*\n${result.content}`,
          },
        },
        { type: "divider" },
      ]),
    ];

    await respond({ blocks });
  } catch (err) {
    await respond(`Error searching docs: ${err.message}`);
  }
});

(async () => {
  await app.start(process.env.PORT || 3000);
  console.log("Slack bot is running");
})();

Legen Sie JAMDESK_API_KEY in den Umgebungsvariablen Ihrer Slack-App fest. Speichern Sie den Schlüssel niemals direkt im Code.

---

Hosting in Unterpfaden (Cloudflare Worker)

Wenn Sie Hosting in Unterpfaden verwenden, um Ihre Dokumentation unter einem Pfad Ihrer Domain bereitzustellen (/docs standardmäßig oder einem benutzerdefinierten Unterpfad wie /help), muss die Route /_api ebenfalls über Ihren Cloudflare Worker weitergeleitet werden – zusätzlich zu Ihrem Dokumentationspfad.

Fügen Sie /_api dem Array PROXY_PATHS in Ihrem Worker hinzu. Verwenden Sie dabei das Pfadpräfix, das Sie im Dashboard konfiguriert haben:

const PROXY_PATHS = [
  "/docs",  // or your custom subpath, e.g. "/help"
  "/_jd",
  "/_api",  // Add this line
];

Dadurch wird sichergestellt, dass Suchanfragen an yoursite.com/_api/search (oder an yoursite.com/help/_api/search, wenn Sie einen benutzerdefinierten Unterpfad verwenden) an Ihre Jamdesk-Dokumentationsseite weitergeleitet werden.