Integraciones

La API de búsqueda de documentación está diseñada para integrarse con las herramientas que tu equipo y clientes ya utilizan. Esta guía cubre las integraciones más comunes.

Intercom (Fin AI Agent)

El agente de IA Fin de Intercom admite Conectores de datos: fuentes de búsqueda externas que Fin consulta junto con tus artículos de Intercom. Conecta la API de búsqueda de documentación para que Fin pueda responder preguntas directamente desde tu documentación de Jamdesk.

---

Zendesk (MCP Server)

Las funciones de IA de Zendesk admiten servidores MCP como fuentes de conocimiento. Usa el servidor MCP integrado de Jamdesk para conectar tu documentación a los agentes de IA de Zendesk sin necesidad de código personalizado.

---

Chatbots personalizados

Agrega búsqueda en la documentación a cualquier chatbot o aplicación web con una llamada estándar fetch. CORS está habilitado, por lo que los clientes basados en navegador pueden llamar a la API directamente sin un proxy de backend.

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("---");
});

Crear una herramienta de agente de IA

Pasa los resultados de búsqueda como contexto a un modelo de lenguaje para generar respuestas fundamentadas:

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;
}

---

Bots de Slack

Crea un comando de barra /docs en Slack que busque en tu documentación y publique los resultados en cualquier canal.

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");
})();

Define JAMDESK_API_KEY en las variables de entorno de tu aplicación de Slack. Nunca incluyas la clave directamente en el código.

---

hostAtDocs (Cloudflare Workers)

Si usas hostAtDocs para servir tu documentación en una subruta (p. ej., yoursite.com/docs), la ruta /_api debe ser redirigida a través de tu Cloudflare Worker.

Agrega /_api al array PROXY_PATHS en tu worker:

const PROXY_PATHS = [
  "/docs",
  "/_jd",
  "/_api",  // Add this line
];

Esto garantiza que las solicitudes de búsqueda a yoursite.com/_api/search se reenvíen a tu sitio de documentación de Jamdesk.