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 Project → 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.
What gets indexed
- One document per tag group — endpoints grouped by tag, with method, path, parameters, request/response bodies, and descriptions.
- Schema documents — component schemas with field names, types, and descriptions.
Keep the spec fresh
Click Sync on the source card whenever the spec changes, or set a daily schedule.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.