API Overview - BeforeQuery

The public API powers the widget and all SDKs. It is client-key authenticated and CORS-enabled.

Base URL

https://api.agents.beforequery.com

All public endpoints are under /api/v1/public. Open protocols (/mcp/projects/:projectId, /a2a/projects/:projectId) are root-level.

Endpoints

Method	Path	Description
`POST`	`/api/v1/public/projects/:projectId/chat`	Streaming RAG chat (SSE)
`POST`	`/api/v1/public/threads/:threadId/chat`	Continue a conversation
`GET`	`/api/v1/public/projects/:projectId/ws`	WebSocket chat transport
`POST`	`/api/v1/public/projects/:projectId/search`	Hybrid search
`POST`	`/api/v1/public/projects/:projectId/form-deflect`	Support-form deflection
`POST`	`/api/v1/public/feedback`	Message feedback
`GET`	`/api/v1/public/projects/:projectId/widget-config`	Widget configuration
`GET`	`/api/v1/public/projects/:projectId/suggested-questions`	Suggested questions
`POST`	`/api/v1/public/projects/:projectId/related`	Related articles
`POST`	`/api/v1/public/agents/:agentId/run`	Run an agent (see @beforequery/agents)

Conventions

JSON everywhere; chat responses stream Server-Sent Events.
Restricted documents are always excluded from public-API retrieval.
group_ids — chat, search, form-deflect, and WebSocket requests accept an optional group_ids array to scope retrieval to source groups. The server intersects it with the client key’s allowed_groups: requests can narrow but never widen. Group IDs must belong to the project and the key’s allowed set, otherwise the request fails with 403.

Errors

Standard envelope with an appropriate HTTP status:

{ "error": { "code": "not_found", "message": "..." } }

Rate limits return 429 with a Retry-After header.

Local development

Every endpoint is available on a locally-run API server at http://localhost:8280 (WebSocket: ws://localhost:8280). All SDKs accept a baseUrl override.