thefaqapp

Quickstart

Get from zero to first API call in under 5 minutes.

1. Create an Account

Sign up at thefaq.app and create an organization.

2. Create an API Key

Go to Dashboard → Settings → API Keys and click Create API Key.

Copy the key — it's only shown once:

faq_aBcDeFgHiJkLmNoPqRsTuVwXyZ012345

3. Make Your First Request

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

Response:

{
  "data": [
    {
      "id": "clx...",
      "question": "How do I get started?",
      "answer": "<p>Follow our quickstart guide...</p>",
      "slug": "how-do-i-get-started",
      "published": true,
      "category": { "name": "Getting Started", "slug": "getting-started" },
      "createdAt": "2026-01-15T10:00:00.000Z"
    }
  ],
  "meta": { "pagination": { "page": 1, "limit": 25, "total": 1, "pages": 1 } }
}

4. Use the SDK (Optional)

npm install @faq/sdk
import { createFaqClient } from '@faq/sdk';

const client = createFaqClient({
  apiKey: 'faq_your-api-key',
  organizationSlug: 'your-org-slug',
});

const { questions } = await client.getFaq();
console.log(questions);

5. Create Content via API

With a STARTER plan or higher, you can create content programmatically:

curl -X POST https://www.thefaq.app/api/v1/your-org/questions \
  -H "Authorization: Bearer faq_your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "question": "What are your business hours?",
    "answer": "<p>We are available Monday–Friday, 9am–5pm EST.</p>",
    "published": true
  }'

Next Steps

On this page