Quickstart

Create a workspace and project

Sign in at app.beforequery.com and create a workspace (your organization) and a project (a knowledge base). Point the project at your documentation URL, for example https://docs.example.com.

Add a knowledge source and start a crawl

Your project’s website source is crawled automatically: BeforeQuery discovers your sitemap, respects robots.txt, strips navigation, extracts code blocks, converts pages to markdown, chunks them heading-aware, and embeds every chunk.Works out of the box with Docusaurus, Mintlify, GitBook, ReadMe, VitePress, MkDocs, and Hugo.Want more than a docs site? Add GitHub/GitLab repos, Notion or Confluence, OpenAPI specs, file uploads, and more from the Sources tab.

Test in the Playground

Open the Playground in the dashboard and ask a question. You’ll see the streamed answer with numbered [1] [2] citations linking to your source pages. Iterate on persona, tone, and custom instructions in project settings until the answers feel right.

Create a client key

Under Project → Integration Credentials, create a public client key (bq_pk_…). Public keys are safe to ship in browsers, scoped to a single project, and support an origin allowlist (wildcards like https://*.example.com are supported).

Deploy the widget

Add one script tag to your site:

<script
  async
  src="https://widget.beforequery.com/beforequery-widget.js"
  data-project-id="proj_xxx"
  data-client-key="bq_pk_..."
></script>

That’s it — a floating “Ask AI” launcher appears with streaming chat, citations, instant search, Cmd/Ctrl+K shortcut, and dark-mode sync. See Widget for view modes and full configuration.

Prefer code?

JavaScript SDK
React
cURL (SSE)

npm install @beforequery/sdk

import { BeforeQuery } from "@beforequery/sdk";

const bq = new BeforeQuery({
  projectId: "proj_xxx",
  clientKey: "bq_pk_your_public_key",
});

const { answer, citations } = await bq.chat("How do I set up authentication?");

npm install @beforequery/react @beforequery/sdk

import { BeforeQueryChat } from "@beforequery/react";

export default function DocsPage() {
  return <BeforeQueryChat projectId="proj_xxx" clientKey="bq_pk_..." />;
}

curl -N https://api.agents.beforequery.com/api/v1/public/projects/proj_xxx/chat \
  -H "X-Client-Key: bq_pk_..." \
  -H "Content-Type: application/json" \
  -d '{"query": "How does OAuth work?"}'

Get Started

Knowledge Sources

Knowledge Connectors

Community Sources

Helpdesk Tickets

Deploy

Platform

Account Management

Prefer code?

Next steps

Knowledge sources

API reference

​Prefer code?

​Next steps

Knowledge sources

API reference

Prefer code?

Next steps