Mintplex-Labs/anything-llm
1
0
Fork 0
mirror of https://github.com/Mintplex-Labs/anything-llm.git synced 2026-07-19 22:23:50 -04:00
Code Issues 328 Packages Projects Releases 10 Wiki Activity

[GH-ISSUE #5288] Add comprehensive API reference documentation #4997

New Issue
Closed
opened 2026-06-05 14:51:24 -04:00 by yindo · 0 comments
yindo commented 2026-06-05 14:51:24 -04:00
Owner
Copy Link
Copy Source

Originally created by @Agolid on GitHub (Mar 27, 2026).
Original GitHub issue: https://github.com/Mintplex-Labs/anything-llm/issues/5288

Summary

AnythingLLM has a well-defined OpenAPI spec at server/swagger/openapi.json (58 endpoints, OpenAPI 3.0), but lacks generated API reference documentation in the repository.

Proposal

Generate Markdown API reference docs from the existing OpenAPI spec, organized by feature:

  • Authentication
  • Admin
  • Documents
  • Workspaces
  • Workspace Threads
  • System Settings
  • User Management
  • OpenAI Compatible Endpoints
  • Embed

This would help developers integrating with AnythingLLM API understand available endpoints, request/response formats, and authentication requirements without having to read the raw Swagger JSON.

Suggested location

server/API_REFERENCE.md or docs/API.md

Originally created by @Agolid on GitHub (Mar 27, 2026). Original GitHub issue: https://github.com/Mintplex-Labs/anything-llm/issues/5288 ## Summary AnythingLLM has a well-defined OpenAPI spec at `server/swagger/openapi.json` (58 endpoints, OpenAPI 3.0), but lacks generated API reference documentation in the repository. ## Proposal Generate Markdown API reference docs from the existing OpenAPI spec, organized by feature: - Authentication - Admin - Documents - Workspaces - Workspace Threads - System Settings - User Management - OpenAI Compatible Endpoints - Embed This would help developers integrating with AnythingLLM API understand available endpoints, request/response formats, and authentication requirements without having to read the raw Swagger JSON. ## Suggested location `server/API_REFERENCE.md` or `docs/API.md`
yindo closed this issue 2026-06-05 14:51:24 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Desktop
Docker
Integration Request
Integration Request
OS: Linux
OS: Mobile
OS: Windows
UI/UX
blocked
bug
bug
core-team-only
documentation
duplicate
embed-widget
enhancement
feature request
github_actions
good first issue
investigating
needs info / can't replicate
possible bug
pull-request
Mirrored from GitHub Pull Request
 question
stage: specifications
wontfix
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Mintplex-Labs/anything-llm#4997
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?