AnythingLLM Developer API
API endpoints that enable programmatic reading, writing, and updating of your AnythingLLM instance. UI supplied by Swagger.io.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
API endpoints that enable programmatic reading, writing, and updating of your AnythingLLM instance. UI supplied by Swagger.io.
Endpoints 70
Authentication
- GETGET /v1/auth
/v1/authVerify the attached Authentication header contains a valid API token.
Admin
- GETGET /v1/admin/is-multi-user-mode
/v1/admin/is-multi-user-modeCheck to see if the instance is in multi-user-mode first. Methods are disabled until multi user mode is enabled via the UI. - GETGET /v1/admin/users
/v1/admin/usersCheck to see if the instance is in multi-user-mode first. Methods are disabled until multi user mode is enabled via the UI. - POSTPOST /v1/admin/users/new
/v1/admin/users/newCreate a new user with username and password. Methods are disabled until multi user mode is enabled via the UI. - POSTPOST /v1/admin/users/{id}
/v1/admin/users/:idUpdate existing user settings. Methods are disabled until multi user mode is enabled via the UI. - DELETEDELETE /v1/admin/users/{id}
/v1/admin/users/:idDelete existing user by id. Methods are disabled until multi user mode is enabled via the UI. - GETGET /v1/admin/invites
/v1/admin/invitesList all existing invitations to instance regardless of status. Methods are disabled until multi user mode is enabled via the UI. - POSTPOST /v1/admin/invite/new
/v1/admin/invite/newCreate a new invite code for someone to use to register with instance. Methods are disabled until multi user mode is enabled via the UI. - DELETEDELETE /v1/admin/invite/{id}
/v1/admin/invite/:idDeactivates (soft-delete) invite by id. Methods are disabled until multi user mode is enabled via the UI. - GETGET /v1/admin/workspaces/{workspaceId}/users
/v1/admin/workspaces/:workspaceId/usersRetrieve a list of users with permissions to access the specified workspace. - POSTPOST /v1/admin/workspaces/{workspaceId}/update-users
/v1/admin/workspaces/:workspaceId/update-usersDeprecated. Overwrite workspace permissions to only be accessible by the given user ids and admins. Methods are disabled until multi user mode is enabled via… - POSTPOST /v1/admin/workspaces/{workspaceSlug}/manage-users
/v1/admin/workspaces/:workspaceSlug/manage-usersSet workspace permissions to be accessible by the given user ids and admins. Methods are disabled until multi user mode is enabled via the UI. - POSTPOST /v1/admin/workspace-chats
/v1/admin/workspace-chatsAll chats in the system ordered by most recent. Methods are disabled until multi user mode is enabled via the UI. - POSTPOST /v1/admin/preferences
/v1/admin/preferencesUpdate multi-user preferences for instance. Methods are disabled until multi user mode is enabled via the UI.
Documents
- POSTPOST /v1/document/upload
/v1/document/uploadUpload a new file to AnythingLLM to be parsed and prepared for embedding, with optional metadata. - POSTPOST /v1/document/upload/{folderName}
/v1/document/upload/:folderNameUpload a new file to a specific folder in AnythingLLM to be parsed and prepared for embedding. If the folder does not exist, it will be created. - POSTPOST /v1/document/upload-link
/v1/document/upload-linkUpload a valid URL for AnythingLLM to scrape and prepare for embedding. The link property can be a single URL string or an array of URL strings. Optionally,… - POSTPOST /v1/document/raw-text
/v1/document/raw-textUpload a file by specifying its raw text content and metadata values without having to upload a file. - GETGET /v1/documents
/v1/documentsList of all locally-stored documents in instance. Optionally, pass ?folder=name to fetch the contents of a single folder, paginated with offset and limit… - GETGET /v1/documents/folder/{folderName}
/v1/documents/folder/:folderNameGet all documents stored in a specific folder. Returns every document by default; pass offset and limit to paginate. - GETGET /v1/document/accepted-file-types
/v1/document/accepted-file-typesCheck available filetypes and MIMEs that can be uploaded. - GETGET /v1/document/metadata-schema
/v1/document/metadata-schemaGet the known available metadata schema for when doing a raw-text upload and the acceptable type of value for each key. - GETGET /v1/document/{docName}
/v1/document/:docNameGet a single document by its unique AnythingLLM document name - POSTPOST /v1/document/create-folder
/v1/document/create-folderCreate a new folder inside the documents storage directory. - DELETEDELETE /v1/document/remove-folder
/v1/document/remove-folderRemove a folder and all its contents from the documents storage directory. - POSTPOST /v1/document/move-files
/v1/document/move-filesMove files within the documents storage directory. - GETGET /v1/document/generated-files/{filename}
/v1/document/generated-files/:filenameDownload a file generated by an agent skill (e.g., PDF, DOCX, XLSX, PPTX) or a generated image (img-*.png). The filename is returned in the outputs array of a…
Workspaces
- POSTPOST /v1/workspace/new
/v1/workspace/newCreate a new workspace - GETGET /v1/workspaces
/v1/workspacesList all current workspaces - GETGET /v1/workspace/{slug}
/v1/workspace/:slugGet a workspace by its unique slug. - DELETEDELETE /v1/workspace/{slug}
/v1/workspace/:slugDeletes a workspace by its slug. - POSTPOST /v1/workspace/{slug}/update
/v1/workspace/:slug/updateUpdate workspace settings by its unique slug. - GETGET /v1/workspace/{slug}/chats
/v1/workspace/:slug/chatsGet a workspaces chats regardless of user by its unique slug. - POSTPOST /v1/workspace/{slug}/update-embeddings
/v1/workspace/:slug/update-embeddingsAdd or remove documents from a workspace by its unique slug. - POSTPOST /v1/workspace/{slug}/update-pin
/v1/workspace/:slug/update-pinAdd or remove pin from a document in a workspace by its unique slug. - POSTPOST /v1/workspace/{slug}/chat
/v1/workspace/:slug/chatExecute a chat with a workspace - POSTPOST /v1/workspace/{slug}/stream-chat
/v1/workspace/:slug/stream-chatExecute a streamable chat with a workspace - POSTPOST /v1/workspace/{slug}/vector-search
/v1/workspace/:slug/vector-searchPerform a vector similarity search in a workspace
System Settings
- GETGET /v1/system/env-dump
/v1/system/env-dumpDump all settings to file storage - GETGET /v1/system
/v1/systemGet all current system settings that are defined. - GETGET /v1/system/vector-count
/v1/system/vector-countNumber of all vectors in connected vector database - POSTPOST /v1/system/update-env
/v1/system/update-envUpdate a system setting or preference. - GETGET /v1/system/export-chats
/v1/system/export-chatsExport all of the chats from the system in a known format. Output depends on the type sent. Will be send with the correct header for the output. - DELETEDELETE /v1/system/remove-documents
/v1/system/remove-documentsPermanently remove documents from the system.
Workspace Threads
- POSTPOST /v1/workspace/{slug}/thread/new
/v1/workspace/:slug/thread/newCreate a new workspace thread - POSTPOST /v1/workspace/{slug}/thread/{threadSlug}/update
/v1/workspace/:slug/thread/:threadSlug/updateUpdate thread name by its unique slug. - DELETEDELETE /v1/workspace/{slug}/thread/{threadSlug}
/v1/workspace/:slug/thread/:threadSlugDelete a workspace thread - GETGET /v1/workspace/{slug}/thread/{threadSlug}/chats
/v1/workspace/:slug/thread/:threadSlug/chatsGet chats for a workspace thread - POSTPOST /v1/workspace/{slug}/thread/{threadSlug}/chat
/v1/workspace/:slug/thread/:threadSlug/chatChat with a workspace thread - POSTPOST /v1/workspace/{slug}/thread/{threadSlug}/stream-chat
/v1/workspace/:slug/thread/:threadSlug/stream-chatStream chat with a workspace thread
User Management
- GETGET /v1/users
/v1/usersList all users - GETGET /v1/users/{id}/issue-auth-token
/v1/users/:id/issue-auth-tokenIssue a temporary auth token for a user
OpenAI Compatible Endpoints
- GETGET /v1/openai/models
/v1/openai/modelsGet all available "models" which are workspaces you can use for chatting. - POSTPOST /v1/openai/chat/completions
/v1/openai/chat/completionsExecute a chat with a workspace with OpenAI compatibility. Supports streaming as well. Model must be a workspace slug from /models. - POSTPOST /v1/openai/images/generations
/v1/openai/images/generationsGenerate or edit an image using the system-configured image generation provider. Send a multipart/form-data request with a "prompt" field and an optional… - POSTPOST /v1/openai/embeddings
/v1/openai/embeddingsGet the embeddings of any arbitrary text string. This will use the embedder provider set in the system. Please ensure the token length of each string fits… - GETGET /v1/openai/vector_stores
/v1/openai/vector_storesList all the vector database collections connected to AnythingLLM. These are essentially workspaces but return their unique vector db identifier - this is the…
Embed
- GETGET /v1/embed
/v1/embedList all active embeds - GETGET /v1/embed/{embedUuid}/chats
/v1/embed/:embedUuid/chatsGet all chats for a specific embed - GETGET /v1/embed/{embedUuid}/chats/{sessionUuid}
/v1/embed/:embedUuid/chats/:sessionUuidGet chats for a specific embed and session - POSTPOST /v1/embed/new
/v1/embed/newCreate a new embed configuration - POSTPOST /v1/embed/{embedUuid}
/v1/embed/:embedUuidUpdate an existing embed configuration - DELETEDELETE /v1/embed/{embedUuid}
/v1/embed/:embedUuidDelete an existing embed configuration
MCP Servers
- GETGET /v1/mcp-servers
/v1/mcp-serversList all MCP servers in the config file with their status, config, and available tools. Will boot servers that have not been started yet. - POSTPOST /v1/mcp-servers/new
/v1/mcp-servers/newAdd a new MCP server to the config file and start it. The server is saved even if it fails to start - check running and startError in the response. - POSTPOST /v1/mcp-servers/reload
/v1/mcp-servers/reloadStop all MCP servers and boot them again from the config file. - POSTPOST /v1/mcp-servers/{name}/update
/v1/mcp-servers/:name/updateReplace the definition of an existing MCP server and restart it. The config fully replaces the old one - include the anythingllm block to keep settings like… - POSTPOST /v1/mcp-servers/{name}/toggle
/v1/mcp-servers/:name/toggleStop the MCP server if it is running, otherwise start it. - POSTPOST /v1/mcp-servers/{name}/toggle-tool
/v1/mcp-servers/:name/toggle-toolEnable or disable a single tool of an MCP server. Disabled tools are not given to agents. - DELETEDELETE /v1/mcp-servers/{name}
/v1/mcp-servers/:nameStop the MCP server and remove it from the config file.
API details
- Authentication
- A bearer token in the Authorization header
- Operations
- 70 operations on 67 pathsPOST 35GET 27DELETE 8
1 marked deprecated - Main resources
- Admin 13Documents 13Workspaces 11MCP Servers 7Embed 6System Settings 6Workspace Threads 6OpenAI Compatible Endpoints 5User Management 2Authentication 1
- Response formats
application/jsonapplication/xmltext/event-streamapplication/octet-stream- Description format
- OpenAPI 3.0.0, API version
1.0.0 - Links
- OpenAPI document
How to test the AnythingLLM Developer API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AnythingLLM Developer API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “GET /v1/auth” (GET /v1/auth), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AnythingLLM Developer API?
API endpoints that enable programmatic reading, writing, and updating of your AnythingLLM instance. UI supplied by Swagger.io. It is listed under AI & machine learning and has 70 endpoints.
Who publishes the AnythingLLM Developer API?
It is listed from AnythingLLM (Mintplex Labs)'s public API description (an OpenAPI document), not published by AnythingLLM (Mintplex Labs) on Swastik Codes. Anyone who controls anythingllm.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the AnythingLLM Developer API?
With A bearer token in the Authorization header.
How many endpoints does the AnythingLLM Developer API have?
70 operations on 67 paths (35 POST, 27 GET, 8 DELETE). The largest groups are Admin, Documents, Workspaces, MCP Servers.
Is forking the AnythingLLM Developer API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.