API Docs (Swagger)
FalkorDB Browser includes built-in API documentation at /docs.
Use the Authorize flow before running protected endpoints.
Swagger capabilities
| Feature | Description |
|---|---|
| Built-in docs | Available at /docs. |
| OpenAPI source | Loaded from /api/swagger. |
| Interactive testing | Supports authenticated “Try it out” requests. |
Typical workflow
| Step | Action |
|---|---|
| 1 | Open /docs from the Browser. |
| 2 | Expand the endpoint group and choose an endpoint. |
| 3 | Use Authorize when needed, then run “Try it out”. |
Frequently Asked Questions 3
Where are Browser API docs located?
Open /docs in the Browser app to view Swagger UI.
Where does Swagger load its schema from?
Swagger loads the OpenAPI document from /api/swagger.
Can I test endpoints from the docs page?
Yes. Use the built-in interactive execution flow in Swagger.