Integrations
Preview your published FAQ, then connect it to your website.Visitor preview
Try the FAQ your visitors will use. Only published answers appear here.Loading…
This is a dashboard preview, not a live installation. Browse up to 20 questions; search checks your published FAQ.Install infinite FAQ on your siteUse a publishable key in browser code
No usable API key is loaded here. A key hint is not a usable credential. Browser snippets need a publishable key, which reads published FAQs and search only. Server keys read drafts and edit content, so keep them in server environment variables. Manage API keys
React (Vite / TanStack Start)
Search your published FAQ from the browser with @faqapp/react and a publishable key.VITE_FAQAPP_PUBLISHABLE_KEY holds a publishable key.bash
npm install @faqapp/reacttsx
import { createFAQClient, FAQClientProvider, useSearch } from "@faqapp/react";
import { useState } from "react";
const faq = createFAQClient({
apiKey: import.meta.env.VITE_FAQAPP_PUBLISHABLE_KEY,
organizationSlug: "sitemap.xml"
});
function FaqSearch() {
const [query, setQuery] = useState("");
const { results, loading } = useSearch(query);
return (
<div>
<input value={query} onChange={e => setQuery(e.target.value)} placeholder="Search the FAQ" />
{loading ? <p>Searching…</p> : null}
<ul>
{results?.results.map(result => (
<li key={result.id}>
<strong>{result.question}</strong>
<p>{result.answer}</p>
</li>
))}
</ul>
</div>
);
}
export function HelpCenter() {
return (
<FAQClientProvider client={faq}>
<FaqSearch />
</FAQClientProvider>
);
}curl
Server-side scripts and backends. Use a server key from your environment, never from page code.FAQAPP_SERVER_KEY holds a server key.bash
curl -H "Authorization: Bearer $FAQAPP_SERVER_KEY" \
https://api.thefaq.app/api/v1/sitemap.xml/questionsAI assistants (MCP)
Let Claude Code, Cursor or another MCP client search and read your published FAQ. Read-only. A publishable key covers search and list; answering questions needs a read key.VITE_FAQAPP_PUBLISHABLE_KEY holds a publishable key.bash
claude mcp add --transport http thefaq https://api.thefaq.app/api/v1/sitemap.xml/mcp \
--header "Authorization: Bearer $VITE_FAQAPP_PUBLISHABLE_KEY"Server code (Node, Bun, edge)
Search your FAQ from a backend or an AI agent's tool with @faqapp/core. Keep the server key in your environment.FAQAPP_SERVER_KEY holds a server key.bash
npm install @faqapp/corets
import { createFAQClient } from "@faqapp/core";
const faq = createFAQClient({
apiKey: process.env.FAQAPP_SERVER_KEY,
organizationSlug: "sitemap.xml"
});
export async function searchFaq(query: string) {
const { data } = await faq.search.query({ q: query, limit: 5 });
return data.results.map(result => ({ question: result.question, answer: result.answer }));
}