Docs

The API in five minutes.

Install the SDK, hit the v1 API, render in your own app. Full API reference and recipes for the patterns we see most.

Getting started

Install the SDK. Authenticate. Make your first call. Should take 5 minutes.

Getting started
Install the SDK, make your first API call, and ship FAQ content in your app in five minutes.

How questions, categories, organizations, and API keys fit together.

Organizations, members, and keys
The data model — how organizations, members, and API keys fit together.

Common workflows — publishing, translating, scheduling, migrating from another tool.

CRUD workflows
Common content-management workflows. Create, list, update, organize, and bulk-import questions and categories.
Patterns and recipes
Drop-in patterns for error handling, exhaustive pagination, debounced search, request batching, and periodic export.

Every v1 endpoint with request and response shape.

API reference
Every v1 endpoint. URL, method, body, response shape, error codes.
Questions API
Create, read, update, delete, schedule, and revise questions. The core resource.
API Keys
Publishable keys for browser code, server keys for everything else. Each key carries explicit scopes that control which endpoints it can call.
Categories
Group questions into categories. Categories carry an order, a slug, and an optional description.
Translations
Manage per-organization language config, translate questions and categories, and read translated content.
Search API
Full-text and semantic search across your published questions. Hybrid keyword + intent matching on Pro.
MCP server
Connect Claude Code, Cursor or any MCP client to your published FAQ. Read-only, scoped to one organization by your API key.
Product API
Read the facts thefaqapp learned from your site and the product profile built from them.

@faqapp/core for any JS runtime. @faqapp/react for hooks and SSR.

@faqapp/core
The TypeScript SDK. Wraps the v1 API with a typed client. Runs in Node, Bun, Deno, edge runtimes, and the browser.
@faqapp/react
Client-side React hooks for search, published FAQs, and questions. Built on @faqapp/core.

Drop-in patterns — Next.js app router, AI agent tool, scheduled republish.

Build an infinite FAQ
Keep the familiar FAQ and add an inline question field backed by published answers.
Next.js App Router
Render thefaqapp content in a Next.js 15+ app with server components, revalidation, and client-side search.

Free plan: 1,000 reads per month, one API key, fifty questions. No card. Five minutes from sign-up to first call.