TheFAQApp API

Welcome to the TheFAQApp API

TheFAQApp is an API-first platform for building and managing knowledge bases, help centers, and self-service content. Instead of locking content inside a proprietary dashboard, every piece of functionality is available through a well-documented REST API. The dashboard, SDKs, and widgets are all first-party consumers of the same endpoints you'll use.

Think of it like Stripe for self-service support content — the API is the product, and everything else is a client.

What You Can Build

• Embedded help widgets that surface relevant answers based on the page context
• Custom knowledge base portals using the TypeScript or Next.js SDK
• Automated content pipelines that create, update, and publish questions programmatically
• Search-powered interfaces with full-text and AI-assisted question matching
• Multi-language support portals using the translations API
• Analytics dashboards tracking search queries, content gaps, and deflection rates

How It Works

1. Create an organization and generate an API key from the dashboard
2. Authenticate requests using Bearer token authentication
3. Manage content through RESTful endpoints for questions, categories, and translations
4. Deliver answers via SDKs, widgets, or direct API calls from any application

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

Standard Response Format

All responses follow a consistent envelope so client code stays predictable:

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

Errors also follow a standard structure with machine-readable codes and human-friendly messages. See the Error Handling reference for details.

Plan-Based Access

Every plan includes API access — reading content is always available, even on the free tier. Write access unlocks on Starter and above, while admin-level operations (managing API keys, configuring webhooks, domain settings) require Pro or higher.

Get Started