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, ship FAQ content in your app — in five minutes.
Concepts
How questions, categories, organizations, and API keys fit together.
- Organizations, members, and keys
The data model — how organizations, members, and API keys fit together.
Guides
Common workflows — publishing, translating, scheduling, migrating from another tool.
- CRUD workflows
Common content-management workflows — creating, listing, updating, organizing, and bulk-importing questions and categories.
- Patterns and recipes
Drop-in patterns for robust error handling, exhaustive pagination, debounced search, request batching, and periodic export.
API reference
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
List the API keys for your organization. Each key carries an explicit scope that controls 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.
- Plan
Read your organization's plan, current usage against limits, and the upcoming downgrade window.
- Intake (AI generation)
Paste a URL, get grounded FAQ candidates back. AI-powered ingestion that turns existing content into structured questions.
- Errors
API error envelope, error codes, validation error shape, and SDK error classes.
SDKs
@faqapp/core for any JS runtime. @faqapp/react for hooks and SSR.
- @faqapp/core
The TypeScript SDK. Wraps every v1 endpoint with a typed client. Runs in Node, Bun, Deno, edge, browser.
- @faqapp/react
React hooks and SSR helpers. Wraps @faqapp/core with cache + suspense.
Recipes
Drop-in patterns — Next.js app router, AI agent tool, scheduled republish.
- Next.js App Router
Render thefaqapp content in a Next.js 15+ app with SSR, ISR, and useFaq hooks.
Get an API key. Ship before lunch.
Free plan: 1,000 reads per month, one API key, fifty questions. No card. Five minutes from sign-up to first call.