Integrations

Copy any snippet — pre-filled with your org slug.

curl

Anything that speaks HTTP can call this.

bash
curl -H "Authorization: Bearer <your-api-key>" \
  https://api.thefaq.app/api/v1/sitemap.xml/questions

React (Next.js / Vite / TanStack)

@faqapp/react ships a typed FaqList + hooks. Install:

bash
npm install @faqapp/react
tsx
// app/page.tsx — Next.js + @faqapp/react
import { FaqList } from "@faqapp/react";

export default function Page() {
  return (
    <FaqList
      org="sitemap.xml"
      apiKey={process.env.NEXT_PUBLIC_FAQAPP_KEY!}  // public read-scoped key
    />
  );
}

AI agents (RAG tool)

@faqapp/rag wraps the search endpoint as an LLM tool definition compatible with OpenAI, Anthropic, and Vercel AI SDK.

ts
// AI tool — let your LLM look up FAQs
import { createFaqTool } from "@faqapp/rag";

export const tools = {
  searchFaq: createFaqTool({
    org: "sitemap.xml",
    apiKey: process.env.FAQAPP_KEY!,
    description: "Search this product's FAQ. Use when the user asks 'how do I…' questions."
  })
};