Point BeforeQuery at an OpenAPI spec (JSON or YAML) and it generates structured documentation from it, so users can ask questions like “How do I create a webhook?” or “What fields does the invoice object have?” and get precise, citation-backed answers.

​
Set up an OpenAPI source

1

Publish your spec at a URL

The spec must be fetchable — e.g. https://api.example.com/openapi.json. Both OpenAPI 2.x (Swagger) and 3.x are supported, in JSON or YAML.
2

Add the source

In the dashboard, open Knowledge Base → Sources → Add source, choose OpenAPI, and paste the spec URL. Click Add — the first sync parses the spec immediately.
3

Test API questions

In the Playground, ask about an endpoint or a schema field. Because chunks are heading-aware, citations link to the specific operation or schema that answered the question.

​
Data ingested

  • One document per tag group — endpoints grouped by tag, with method, path, parameters, request and response bodies, and descriptions. Cited at the spec URL with #tag/<name> appended.
  • One document for the data models — component schemas with field names, types, required flags and descriptions.

​
Keep the spec fresh

The spec is re-fetched every hour — there is no schedule to configure, and Sync on the source’s page runs one now if you cannot wait. Only a changed spec is re-embedded. See Sources Overview.
Add a step to your API deployment pipeline that triggers a sync of this source, so the assistant is never behind your published API.

​
Works well with

  • A website source for your prose API guides — spec + guides answer together.
  • The MCP server, so developers can query your API reference directly from their IDE.