Frequently Asked Questions

TheFAQApp is an API-first FAQ platform for modern products. It gives you a REST API, TypeScript SDKs, and embeddable widgets to manage, search, and serve FAQ content anywhere: your app, your docs, your chatbot.

Every organization gets a hosted FAQ portal with search, categories, and SEO optimization out of the box. You can also map it to your own custom domain.

Getting started takes about 2 minutes:

1. Sign up at thefaq.app and create an organization
2. Add categories to organize your content (e.g., Getting Started, Billing, Features)
3. Create questions — write them manually or use AI generation to draft answers from your existing docs
4. Publish — your FAQ portal is live instantly at your-slug.thefaq.app

You can also create content programmatically via the API with a Starter plan or higher.

Yes! You can import FAQ content in several ways:

• API — Use the REST API to programmatically create questions and categories
• AI Generation — Paste a URL or text and let AI generate FAQ entries from your existing content
• Manual — Copy and paste into the rich text editor

We're also working on CSV import and direct integrations with popular help desk tools.

TheFAQApp offers four plans:

• Free — 1 API key, read-only access, 1,000 requests/month. Perfect for trying it out.
• Starter ($19/mo) — 5 API keys, read + write access, 10,000 requests/month. Great for small teams.
• Pro ($49/mo) — Unlimited API keys, full access, 100,000 requests/month, webhooks, custom domains, and priority support.
• Enterprise — Custom limits, SLA, SSO/SAML, and dedicated support. Contact us for pricing.

All plans include the hosted FAQ portal, embeddable widgets, and AI-assisted content generation.

Yes, you can upgrade or downgrade your plan at any time from your dashboard under Settings → Billing.

When upgrading, the new plan takes effect immediately and you'll be charged a prorated amount. When downgrading, the change takes effect at the end of your current billing cycle.

The Free plan is free forever — no credit card required. It includes read-only API access, 1 API key, and 1,000 requests per month.

If you need write access or more capacity, you can upgrade to Starter or Pro at any time. There's no separate "trial" because the Free plan already lets you evaluate the full platform.

If you exceed your monthly request limit, API calls will return a 429 Rate Limit Exceeded response. Your FAQ portal and widgets will continue to work thanks to edge caching.

You can monitor your usage in the dashboard. We'll also send you an email when you reach 80% and 100% of your limit. Upgrading your plan increases your limit immediately.

All API requests require a Bearer token. Create API keys in your dashboard under Settings → API Keys.

Include the key in the Authorization header:

curl https://www.thefaq.app/api/v1/your-org/questions \
  -H "Authorization: Bearer faq_your-api-key"

API keys have scopes (read, write, admin) depending on your plan. Free plans get read-only keys; Starter and above get read+write.

We offer two first-party TypeScript packages:

• @faqapp/core — Type-safe API client with full CRUD operations, pagination, error handling, and retry logic. Works in any JavaScript/TypeScript environment.
• @faqapp/nextjs — React hooks and SSR/SSG helpers built on top of @faqapp/core. Includes useFaq(), useQuestion(), and server-side data fetching utilities.

npm install @faqapp/core
# or for Next.js projects:
npm install @faqapp/nextjs

Yes. All list endpoints return paginated results with a standard envelope:

{
  "data": [...],
  "meta": {
    "pagination": {
      "page": 1,
      "limit": 25,
      "total": 42,
      "pages": 2
    }
  }
}

Use ?page=2&limit=10 query parameters to navigate. The SDK handles pagination automatically with .list() and async iteration.

Add a single script tag to your page:

<script
  src="https://www.thefaq.app/widget/embed.js"
  data-org="your-org-slug"
  data-theme="light"
></script>

The widget includes search, category filtering, and accordion-style Q&A — all powered by the same API. You can customize colors, fonts, and layout to match your brand.

Yes. The widget supports several customization options:

• Theme — Light or dark mode
• Colors — Primary accent color, background, text colors
• Layout — Accordion, list, or card view
• Categories — Show all or filter to specific categories
• Search — Enable or disable the search bar

Configure these in your dashboard under Settings → Widgets, or pass them as data-* attributes on the script tag.

Custom domains are available on the Pro plan and above. To set one up:

1. Go to Settings → Domains in your dashboard
2. Enter your domain (e.g., faq.yourcompany.com)
3. Add the CNAME record we provide to your DNS settings
4. Wait for DNS propagation and SSL provisioning (usually 5-15 minutes)

Once verified, your FAQ portal will be accessible at your custom domain with automatic HTTPS.

Yes, SSL certificates are automatically provisioned and renewed for all custom domains. There's nothing to configure — HTTPS just works.

API keys have three scope levels:

• read — List and retrieve questions, categories, and search. Available on all plans.
• write — Create, update, and delete content. Available on Starter and above.
• admin — Manage organization settings, API keys, and webhooks. Available on Pro and above.

Each API key is assigned scopes when created. Use the principle of least privilege — give each key only the scopes it needs.

Go to Settings → Team in your dashboard. You can invite team members by email and assign roles:

• Owner — Full access, billing management, can delete the organization
• Admin — Full content access, can manage team members and settings
• Member — Can create and edit content
• Viewer — Read-only access to the dashboard

Team size is unlimited on all plans.