SchSeba/openwebui-go-sdk

★ 0Forks 0ShellGitHub ↗Compare

README

Go API client for openwebui

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 0.1.0
  • Package version: 1.0.0
  • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openwebui "github.com/SchSeba/openwebui-go-sdk"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value openwebui.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openwebui.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value openwebui.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openwebui.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using openwebui.ContextOperationServerIndices and openwebui.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openwebui.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openwebui.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AudioAPI GetAudioConfigApiV1AudioConfigGet Get /api/v1/audio/config Get Audio Config
AudioAPI GetModelsApiV1AudioModelsGet Get /api/v1/audio/models Get Models
AudioAPI GetVoicesApiV1AudioVoicesGet Get /api/v1/audio/voices Get Voices
AudioAPI SpeechApiV1AudioSpeechPost Post /api/v1/audio/speech Speech
AudioAPI TranscriptionApiV1AudioTranscriptionsPost Post /api/v1/audio/transcriptions Transcription
AudioAPI UpdateAudioConfigApiV1AudioConfigUpdatePost Post /api/v1/audio/config/update Update Audio Config
AuthsAPI AddUserApiV1AuthsAddPost Post /api/v1/auths/add Add User
AuthsAPI DeleteApiKeyApiV1AuthsApiKeyDelete Delete /api/v1/auths/api_key Delete Api Key
AuthsAPI GenerateApiKeyApiV1AuthsApiKeyPost Post /api/v1/auths/api_key Generate Api Key
AuthsAPI GetAdminConfigApiV1AuthsAdminConfigGet Get /api/v1/auths/admin/config Get Admin Config
AuthsAPI GetAdminDetailsApiV1AuthsAdminDetailsGet Get /api/v1/auths/admin/details Get Admin Details
AuthsAPI GetApiKeyApiV1AuthsApiKeyGet Get /api/v1/auths/api_key Get Api Key
AuthsAPI GetLdapConfigApiV1AuthsAdminConfigLdapGet Get /api/v1/auths/admin/config/ldap Get Ldap Config
AuthsAPI GetLdapServerApiV1AuthsAdminConfigLdapServerGet Get /api/v1/auths/admin/config/ldap/server Get Ldap Server
AuthsAPI GetSessionUserApiV1AuthsGet Get /api/v1/auths/ Get Session User
AuthsAPI LdapAuthApiV1AuthsLdapPost Post /api/v1/auths/ldap Ldap Auth
AuthsAPI SigninApiV1AuthsSigninPost Post /api/v1/auths/signin Signin
AuthsAPI SignoutApiV1AuthsSignoutGet Get /api/v1/auths/signout Signout
AuthsAPI SignupApiV1AuthsSignupPost Post /api/v1/auths/signup Signup
AuthsAPI UpdateAdminConfigApiV1AuthsAdminConfigPost Post /api/v1/auths/admin/config Update Admin Config
AuthsAPI UpdateLdapConfigApiV1AuthsAdminConfigLdapPost Post /api/v1/auths/admin/config/ldap Update Ldap Config
AuthsAPI UpdateLdapServerApiV1AuthsAdminConfigLdapServerPost Post /api/v1/auths/admin/config/ldap/server Update Ldap Server
AuthsAPI UpdatePasswordApiV1AuthsUpdatePasswordPost Post /api/v1/auths/update/password Update Password
AuthsAPI UpdateProfileApiV1AuthsUpdateProfilePost Post /api/v1/auths/update/profile Update Profile
ChannelsAPI AddReactionToMessageApiV1ChannelsIdMessagesMessageIdReactionsAddPost Post /api/v1/channels/{id}/messages/{message_id}/reactions/add Add Reaction To Message
ChannelsAPI CreateNewChannelApiV1ChannelsCreatePost Post /api/v1/channels/create Create New Channel
ChannelsAPI DeleteChannelByIdApiV1ChannelsIdDeleteDelete Delete /api/v1/channels/{id}/delete Delete Channel By Id
ChannelsAPI DeleteMessageByIdApiV1ChannelsIdMessagesMessageIdDeleteDelete Delete /api/v1/channels/{id}/messages/{message_id}/delete Delete Message By Id
ChannelsAPI GetAllChannelsApiV1ChannelsListGet Get /api/v1/channels/list Get All Channels
ChannelsAPI GetChannelByIdApiV1ChannelsIdGet Get /api/v1/channels/{id} Get Channel By Id
ChannelsAPI GetChannelMessageApiV1ChannelsIdMessagesMessageIdGet Get /api/v1/channels/{id}/messages/{message_id} Get Channel Message
ChannelsAPI GetChannelMessagesApiV1ChannelsIdMessagesGet Get /api/v1/channels/{id}/messages Get Channel Messages
ChannelsAPI GetChannelThreadMessagesApiV1ChannelsIdMessagesMessageIdThreadGet Get /api/v1/channels/{id}/messages/{message_id}/thread Get Channel Thread Messages
ChannelsAPI GetChannelsApiV1ChannelsGet Get /api/v1/channels/ Get Channels
ChannelsAPI PostNewMessageApiV1ChannelsIdMessagesPostPost Post /api/v1/channels/{id}/messages/post Post New Message
ChannelsAPI RemoveReactionByIdAndUserIdAndNameApiV1ChannelsIdMessagesMessageIdReactionsRemovePost Post /api/v1/channels/{id}/messages/{message_id}/reactions/remove Remove Reaction By Id And User Id And Name
ChannelsAPI UpdateChannelByIdApiV1ChannelsIdUpdatePost Post /api/v1/channels/{id}/update Update Channel By Id
ChannelsAPI UpdateMessageByIdApiV1ChannelsIdMessagesMessageIdUpdatePost Post /api/v1/channels/{id}/messages/{message_id}/update Update Message By Id
ChatsAPI AddTagByIdAndTagNameApiV1ChatsIdTagsPost Post /api/v1/chats/{id}/tags Add Tag By Id And Tag Name
ChatsAPI ArchiveAllChatsApiV1ChatsArchiveAllPost Post /api/v1/chats/archive/all Archive All Chats
ChatsAPI ArchiveChatByIdApiV1ChatsIdArchivePost Post /api/v1/chats/{id}/archive Archive Chat By Id
ChatsAPI CloneChatByIdApiV1ChatsIdClonePost Post /api/v1/chats/{id}/clone Clone Chat By Id
ChatsAPI CloneSharedChatByIdApiV1ChatsIdCloneSharedPost Post /api/v1/chats/{id}/clone/shared Clone Shared Chat By Id
ChatsAPI CreateNewChatApiV1ChatsNewPost Post /api/v1/chats/new Create New Chat
ChatsAPI DeleteAllTagsByIdApiV1ChatsIdTagsAllDelete Delete /api/v1/chats/{id}/tags/all Delete All Tags By Id
ChatsAPI DeleteAllUserChatsApiV1ChatsDelete Delete /api/v1/chats/ Delete All User Chats
ChatsAPI DeleteChatByIdApiV1ChatsIdDelete Delete /api/v1/chats/{id} Delete Chat By Id
ChatsAPI DeleteSharedChatByIdApiV1ChatsIdShareDelete Delete /api/v1/chats/{id}/share Delete Shared Chat By Id
ChatsAPI DeleteTagByIdAndTagNameApiV1ChatsIdTagsDelete Delete /api/v1/chats/{id}/tags Delete Tag By Id And Tag Name
ChatsAPI GetAllUserChatsInDbApiV1ChatsAllDbGet Get /api/v1/chats/all/db Get All User Chats In Db
ChatsAPI GetAllUserTagsApiV1ChatsAllTagsGet Get /api/v1/chats/all/tags Get All User Tags
ChatsAPI GetArchivedSessionUserChatListApiV1ChatsArchivedGet Get /api/v1/chats/archived Get Archived Session User Chat List
ChatsAPI GetChatByIdApiV1ChatsIdGet Get /api/v1/chats/{id} Get Chat By Id
ChatsAPI GetChatTagsByIdApiV1ChatsIdTagsGet Get /api/v1/chats/{id}/tags Get Chat Tags By Id
ChatsAPI GetChatsByFolderIdApiV1ChatsFolderFolderIdGet Get /api/v1/chats/folder/{folder_id} Get Chats By Folder Id
ChatsAPI GetPinnedStatusByIdApiV1ChatsIdPinnedGet Get /api/v1/chats/{id}/pinned Get Pinned Status By Id
ChatsAPI GetSessionUserChatListApiV1ChatsGet Get /api/v1/chats/ Get Session User Chat List
ChatsAPI GetSessionUserChatListApiV1ChatsListGet Get /api/v1/chats/list Get Session User Chat List
ChatsAPI GetSharedChatByIdApiV1ChatsShareShareIdGet Get /api/v1/chats/share/{share_id} Get Shared Chat By Id
ChatsAPI GetUserArchivedChatsApiV1ChatsAllArchivedGet Get /api/v1/chats/all/archived Get User Archived Chats
ChatsAPI GetUserChatListByTagNameApiV1ChatsTagsPost Post /api/v1/chats/tags Get User Chat List By Tag Name
ChatsAPI GetUserChatListByUserIdApiV1ChatsListUserUserIdGet Get /api/v1/chats/list/user/{user_id} Get User Chat List By User Id
ChatsAPI GetUserChatsApiV1ChatsAllGet Get /api/v1/chats/all Get User Chats
ChatsAPI GetUserPinnedChatsApiV1ChatsPinnedGet Get /api/v1/chats/pinned Get User Pinned Chats
ChatsAPI ImportChatApiV1ChatsImportPost Post /api/v1/chats/import Import Chat
ChatsAPI PinChatByIdApiV1ChatsIdPinPost Post /api/v1/chats/{id}/pin Pin Chat By Id
ChatsAPI SearchUserChatsApiV1ChatsSearchGet Get /api/v1/chats/search Search User Chats
ChatsAPI SendChatMessageEventByIdApiV1ChatsIdMessagesMessageIdEventPost Post /api/v1/chats/{id}/messages/{message_id}/event Send Chat Message Event By Id
ChatsAPI ShareChatByIdApiV1ChatsIdSharePost Post /api/v1/chats/{id}/share Share Chat By Id
ChatsAPI UpdateChatByIdApiV1ChatsIdPost Post /api/v1/chats/{id} Update Chat By Id
ChatsAPI UpdateChatFolderIdByIdApiV1ChatsIdFolderPost Post /api/v1/chats/{id}/folder Update Chat Folder Id By Id
ChatsAPI UpdateChatMessageByIdApiV1ChatsIdMessagesMessageIdPost Post /api/v1/chats/{id}/messages/{message_id} Update Chat Message By Id
ConfigsAPI ExportConfigApiV1ConfigsExportGet Get /api/v1/configs/export Export Config
ConfigsAPI GetBannersApiV1ConfigsBannersGet Get /api/v1/configs/banners Get Banners
ConfigsAPI GetCodeExecutionConfigApiV1ConfigsCodeExecutionGet Get /api/v1/configs/code_execution Get Code Execution Config
ConfigsAPI GetConnectionsConfigApiV1ConfigsConnectionsGet Get /api/v1/configs/connections Get Connections Config
ConfigsAPI GetModelsConfigApiV1ConfigsModelsGet Get /api/v1/configs/models Get Models Config
ConfigsAPI GetToolServersConfigApiV1ConfigsToolServersGet Get /api/v1/configs/tool_servers Get Tool Servers Config
ConfigsAPI ImportConfigApiV1ConfigsImportPost Post /api/v1/configs/import Import Config
ConfigsAPI SetBannersApiV1ConfigsBannersPost Post /api/v1/configs/banners Set Banners
ConfigsAPI SetCodeExecutionConfigApiV1ConfigsCodeExecutionPost Post /api/v1/configs/code_execution Set Code Execution Config
ConfigsAPI SetConnectionsConfigApiV1ConfigsConnectionsPost Post /api/v1/configs/connections Set Connections Config
ConfigsAPI SetDefaultSuggestionsApiV1ConfigsSuggestionsPost Post /api/v1/configs/suggestions Set Default Suggestions
ConfigsAPI SetModelsConfigApiV1ConfigsModelsPost Post /api/v1/configs/models Set Models Config
ConfigsAPI SetToolServersConfigApiV1ConfigsToolServersPost Post /api/v1/configs/tool_servers Set Tool Servers Config
ConfigsAPI VerifyToolServersConfigApiV1ConfigsToolServersVerifyPost Post /api/v1/configs/tool_servers/verify Verify Tool Servers Config
DefaultAPI ChatActionApiChatActionsActionIdPost Post /api/chat/actions/{action_id} Chat Action
DefaultAPI ChatCompletedApiChatCompletedPost Post /api/chat/completed Chat Completed
DefaultAPI ChatCompletionApiChatCompletionsPost Post /api/chat/completions Chat Completion
DefaultAPI EmbeddingsApiEmbeddingsPost Post /api/embeddings Embeddings
DefaultAPI GetAppChangelogApiChangelogGet Get /api/changelog Get App Changelog
DefaultAPI GetAppConfigApiConfigGet Get /api/config Get App Config
DefaultAPI GetAppLatestReleaseVersionApiVersionUpdatesGet Get /api/version/updates Get App Latest Release Version
DefaultAPI GetAppVersionApiVersionGet Get /api/version Get App Version
DefaultAPI GetBaseModelsApiModelsBaseGet Get /api/models/base Get Base Models
DefaultAPI GetCurrentUsageApiUsageGet Get /api/usage Get Current Usage
DefaultAPI GetManifestJsonManifestJsonGet Get /manifest.json Get Manifest Json
DefaultAPI GetModelsApiModelsGet Get /api/models Get Models
DefaultAPI GetOpensearchXmlOpensearchXmlGet Get /opensearch.xml Get Opensearch Xml
DefaultAPI GetWebhookUrlApiWebhookGet Get /api/webhook Get Webhook Url
DefaultAPI HealthcheckHealthGet Get /health Healthcheck
DefaultAPI HealthcheckWithDbHealthDbGet Get /health/db Healthcheck With Db
DefaultAPI ListTasksByChatIdEndpointApiTasksChatChatIdGet Get /api/tasks/chat/{chat_id} List Tasks By Chat Id Endpoint
DefaultAPI ListTasksEndpointApiTasksGet Get /api/tasks List Tasks Endpoint
DefaultAPI OauthCallbackOauthProviderCallbackGet Get /oauth/{provider}/callback Oauth Callback
DefaultAPI OauthLoginOauthProviderLoginGet Get /oauth/{provider}/login Oauth Login
DefaultAPI ServeCacheFileCachePathGet Get /cache/{path} Serve Cache File
DefaultAPI StopTaskEndpointApiTasksStopTaskIdPost Post /api/tasks/stop/{task_id} Stop Task Endpoint
DefaultAPI UpdateWebhookUrlApiWebhookPost Post /api/webhook Update Webhook Url
EvaluationsAPI CreateFeedbackApiV1EvaluationsFeedbackPost Post /api/v1/evaluations/feedback Create Feedback
EvaluationsAPI DeleteAllFeedbacksApiV1EvaluationsFeedbacksAllDelete Delete /api/v1/evaluations/feedbacks/all Delete All Feedbacks
EvaluationsAPI DeleteFeedbackByIdApiV1EvaluationsFeedbackIdDelete Delete /api/v1/evaluations/feedback/{id} Delete Feedback By Id
EvaluationsAPI DeleteFeedbacksApiV1EvaluationsFeedbacksDelete Delete /api/v1/evaluations/feedbacks Delete Feedbacks
EvaluationsAPI GetAllFeedbacksApiV1EvaluationsFeedbacksAllExportGet Get /api/v1/evaluations/feedbacks/all/export Get All Feedbacks
EvaluationsAPI GetAllFeedbacksApiV1EvaluationsFeedbacksAllGet Get /api/v1/evaluations/feedbacks/all Get All Feedbacks
EvaluationsAPI GetConfigApiV1EvaluationsConfigGet Get /api/v1/evaluations/config Get Config
EvaluationsAPI GetFeedbackByIdApiV1EvaluationsFeedbackIdGet Get /api/v1/evaluations/feedback/{id} Get Feedback By Id
EvaluationsAPI GetFeedbacksApiV1EvaluationsFeedbacksUserGet Get /api/v1/evaluations/feedbacks/user Get Feedbacks
EvaluationsAPI UpdateConfigApiV1EvaluationsConfigPost Post /api/v1/evaluations/config Update Config
EvaluationsAPI UpdateFeedbackByIdApiV1EvaluationsFeedbackIdPost Post /api/v1/evaluations/feedback/{id} Update Feedback By Id
FilesAPI DeleteAllFilesApiV1FilesAllDelete Delete /api/v1/files/all Delete All Files
FilesAPI DeleteFileByIdApiV1FilesIdDelete Delete /api/v1/files/{id} Delete File By Id
FilesAPI GetFileByIdApiV1FilesIdGet Get /api/v1/files/{id} Get File By Id
FilesAPI GetFileContentByIdApiV1FilesIdContentFileNameGet Get /api/v1/files/{id}/content/{file_name} Get File Content By Id
FilesAPI GetFileContentByIdApiV1FilesIdContentGet Get /api/v1/files/{id}/content Get File Content By Id
FilesAPI GetFileDataContentByIdApiV1FilesIdDataContentGet Get /api/v1/files/{id}/data/content Get File Data Content By Id
FilesAPI GetHtmlFileContentByIdApiV1FilesIdContentHtmlGet Get /api/v1/files/{id}/content/html Get Html File Content By Id
FilesAPI ListFilesApiV1FilesGet Get /api/v1/files/ List Files
FilesAPI SearchFilesApiV1FilesSearchGet Get /api/v1/files/search Search Files
FilesAPI UpdateFileDataContentByIdApiV1FilesIdDataContentUpdatePost Post /api/v1/files/{id}/data/content/update Update File Data Content By Id
FilesAPI UploadFileApiV1FilesPost Post /api/v1/files/ Upload File
FoldersAPI CreateFolderApiV1FoldersPost Post /api/v1/folders/ Create Folder
FoldersAPI DeleteFolderByIdApiV1FoldersIdDelete Delete /api/v1/folders/{id} Delete Folder By Id
FoldersAPI GetFolderByIdApiV1FoldersIdGet Get /api/v1/folders/{id} Get Folder By Id
FoldersAPI GetFoldersApiV1FoldersGet Get /api/v1/folders/ Get Folders
FoldersAPI UpdateFolderIsExpandedByIdApiV1FoldersIdUpdateExpandedPost Post /api/v1/folders/{id}/update/expanded Update Folder Is Expanded By Id
FoldersAPI UpdateFolderNameByIdApiV1FoldersIdUpdatePost Post /api/v1/folders/{id}/update Update Folder Name By Id
FoldersAPI UpdateFolderParentIdByIdApiV1FoldersIdUpdateParentPost Post /api/v1/folders/{id}/update/parent Update Folder Parent Id By Id
FunctionsAPI CreateNewFunctionApiV1FunctionsCreatePost Post /api/v1/functions/create Create New Function
FunctionsAPI DeleteFunctionByIdApiV1FunctionsIdIdDeleteDelete Delete /api/v1/functions/id/{id}/delete Delete Function By Id
FunctionsAPI GetFunctionByIdApiV1FunctionsIdIdGet Get /api/v1/functions/id/{id} Get Function By Id
FunctionsAPI GetFunctionUserValvesByIdApiV1FunctionsIdIdValvesUserGet Get /api/v1/functions/id/{id}/valves/user Get Function User Valves By Id
FunctionsAPI GetFunctionUserValvesSpecByIdApiV1FunctionsIdIdValvesUserSpecGet Get /api/v1/functions/id/{id}/valves/user/spec Get Function User Valves Spec By Id
FunctionsAPI GetFunctionValvesByIdApiV1FunctionsIdIdValvesGet Get /api/v1/functions/id/{id}/valves Get Function Valves By Id
FunctionsAPI GetFunctionValvesSpecByIdApiV1FunctionsIdIdValvesSpecGet Get /api/v1/functions/id/{id}/valves/spec Get Function Valves Spec By Id
FunctionsAPI GetFunctionsApiV1FunctionsExportGet Get /api/v1/functions/export Get Functions
FunctionsAPI GetFunctionsApiV1FunctionsGet Get /api/v1/functions/ Get Functions
FunctionsAPI LoadFunctionFromUrlApiV1FunctionsLoadUrlPost Post /api/v1/functions/load/url Load Function From Url
FunctionsAPI SyncFunctionsApiV1FunctionsSyncPost Post /api/v1/functions/sync Sync Functions
FunctionsAPI ToggleFunctionByIdApiV1FunctionsIdIdTogglePost Post /api/v1/functions/id/{id}/toggle Toggle Function By Id
FunctionsAPI ToggleGlobalByIdApiV1FunctionsIdIdToggleGlobalPost Post /api/v1/functions/id/{id}/toggle/global Toggle Global By Id
FunctionsAPI UpdateFunctionByIdApiV1FunctionsIdIdUpdatePost Post /api/v1/functions/id/{id}/update Update Function By Id
FunctionsAPI UpdateFunctionUserValvesByIdApiV1FunctionsIdIdValvesUserUpdatePost Post /api/v1/functions/id/{id}/valves/user/update Update Function User Valves By Id
FunctionsAPI UpdateFunctionValvesByIdApiV1FunctionsIdIdValvesUpdatePost Post /api/v1/functions/id/{id}/valves/update Update Function Valves By Id
GroupsAPI AddUserToGroupApiV1GroupsIdIdUsersAddPost Post /api/v1/groups/id/{id}/users/add Add User To Group
GroupsAPI CreateNewGroupApiV1GroupsCreatePost Post /api/v1/groups/create Create New Group
GroupsAPI DeleteGroupByIdApiV1GroupsIdIdDeleteDelete Delete /api/v1/groups/id/{id}/delete Delete Group By Id
GroupsAPI GetGroupByIdApiV1GroupsIdIdGet Get /api/v1/groups/id/{id} Get Group By Id
GroupsAPI GetGroupsApiV1GroupsGet Get /api/v1/groups/ Get Groups
GroupsAPI RemoveUsersFromGroupApiV1GroupsIdIdUsersRemovePost Post /api/v1/groups/id/{id}/users/remove Remove Users From Group
GroupsAPI UpdateGroupByIdApiV1GroupsIdIdUpdatePost Post /api/v1/groups/id/{id}/update Update Group By Id
ImagesAPI GetConfigApiV1ImagesConfigGet Get /api/v1/images/config Get Config
ImagesAPI GetImageConfigApiV1ImagesImageConfigGet Get /api/v1/images/image/config Get Image Config
ImagesAPI GetModelsApiV1ImagesModelsGet Get /api/v1/images/models Get Models
ImagesAPI ImageGenerationsApiV1ImagesGenerationsPost Post /api/v1/images/generations Image Generations
ImagesAPI UpdateConfigApiV1ImagesConfigUpdatePost Post /api/v1/images/config/update Update Config
ImagesAPI UpdateImageConfigApiV1ImagesImageConfigUpdatePost Post /api/v1/images/image/config/update Update Image Config
ImagesAPI VerifyUrlApiV1ImagesConfigUrlVerifyGet Get /api/v1/images/config/url/verify Verify Url
KnowledgeAPI AddFileToKnowledgeByIdApiV1KnowledgeIdFileAddPost Post /api/v1/knowledge/{id}/file/add Add File To Knowledge By Id
KnowledgeAPI AddFilesToKnowledgeBatchApiV1KnowledgeIdFilesBatchAddPost Post /api/v1/knowledge/{id}/files/batch/add Add Files To Knowledge Batch
KnowledgeAPI CreateNewKnowledgeApiV1KnowledgeCreatePost Post /api/v1/knowledge/create Create New Knowledge
KnowledgeAPI DeleteKnowledgeByIdApiV1KnowledgeIdDeleteDelete Delete /api/v1/knowledge/{id}/delete Delete Knowledge By Id
KnowledgeAPI GetKnowledgeApiV1KnowledgeGet Get /api/v1/knowledge/ Get Knowledge
KnowledgeAPI GetKnowledgeByIdApiV1KnowledgeIdGet Get /api/v1/knowledge/{id} Get Knowledge By Id
KnowledgeAPI GetKnowledgeListApiV1KnowledgeListGet Get /api/v1/knowledge/list Get Knowledge List
KnowledgeAPI ReindexKnowledgeFilesApiV1KnowledgeReindexPost Post /api/v1/knowledge/reindex Reindex Knowledge Files
KnowledgeAPI RemoveFileFromKnowledgeByIdApiV1KnowledgeIdFileRemovePost Post /api/v1/knowledge/{id}/file/remove Remove File From Knowledge By Id
KnowledgeAPI ResetKnowledgeByIdApiV1KnowledgeIdResetPost Post /api/v1/knowledge/{id}/reset Reset Knowledge By Id
KnowledgeAPI UpdateFileFromKnowledgeByIdApiV1KnowledgeIdFileUpdatePost Post /api/v1/knowledge/{id}/file/update Update File From Knowledge By Id
KnowledgeAPI UpdateKnowledgeByIdApiV1KnowledgeIdUpdatePost Post /api/v1/knowledge/{id}/update Update Knowledge By Id
MemoriesAPI AddMemoryApiV1MemoriesAddPost Post /api/v1/memories/add Add Memory
MemoriesAPI DeleteMemoryByIdApiV1MemoriesMemoryIdDelete Delete /api/v1/memories/{memory_id} Delete Memory By Id
MemoriesAPI DeleteMemoryByUserIdApiV1MemoriesDeleteUserDelete Delete /api/v1/memories/delete/user Delete Memory By User Id
MemoriesAPI GetEmbeddingsApiV1MemoriesEfGet Get /api/v1/memories/ef Get Embeddings
MemoriesAPI GetMemoriesApiV1MemoriesGet Get /api/v1/memories/ Get Memories
MemoriesAPI QueryMemoryApiV1MemoriesQueryPost Post /api/v1/memories/query Query Memory
MemoriesAPI ResetMemoryFromVectorDbApiV1MemoriesResetPost Post /api/v1/memories/reset Reset Memory From Vector Db
MemoriesAPI UpdateMemoryByIdApiV1MemoriesMemoryIdUpdatePost Post /api/v1/memories/{memory_id}/update Update Memory By Id
ModelsAPI CreateNewModelApiV1ModelsCreatePost Post /api/v1/models/create Create New Model
ModelsAPI DeleteAllModelsApiV1ModelsDeleteAllDelete Delete /api/v1/models/delete/all Delete All Models
ModelsAPI DeleteModelByIdApiV1ModelsModelDeleteDelete Delete /api/v1/models/model/delete Delete Model By Id
ModelsAPI GetBaseModelsApiV1ModelsBaseGet Get /api/v1/models/base Get Base Models
ModelsAPI GetModelByIdApiV1ModelsModelGet Get /api/v1/models/model Get Model By Id
ModelsAPI GetModelsApiV1ModelsGet Get /api/v1/models/ Get Models
ModelsAPI ToggleModelByIdApiV1ModelsModelTogglePost Post /api/v1/models/model/toggle Toggle Model By Id
ModelsAPI UpdateModelByIdApiV1ModelsModelUpdatePost Post /api/v1/models/model/update Update Model By Id
NotesAPI CreateNewNoteApiV1NotesCreatePost Post /api/v1/notes/create Create New Note
NotesAPI DeleteNoteByIdApiV1NotesIdDeleteDelete Delete /api/v1/notes/{id}/delete Delete Note By Id
NotesAPI GetNoteByIdApiV1NotesIdGet Get /api/v1/notes/{id} Get Note By Id
NotesAPI GetNoteListApiV1NotesListGet Get /api/v1/notes/list Get Note List
NotesAPI GetNotesApiV1NotesGet Get /api/v1/notes/ Get Notes
NotesAPI UpdateNoteByIdApiV1NotesIdUpdatePost Post /api/v1/notes/{id}/update Update Note By Id
OllamaAPI CopyModelOllamaApiCopyPost Post /ollama/api/copy Copy Model
OllamaAPI CopyModelOllamaApiCopyUrlIdxPost Post /ollama/api/copy/{url_idx} Copy Model
OllamaAPI CreateModelOllamaApiCreatePost Post /ollama/api/create Create Model
OllamaAPI CreateModelOllamaApiCreateUrlIdxPost Post /ollama/api/create/{url_idx} Create Model
OllamaAPI DeleteModelOllamaApiDeleteDelete Delete /ollama/api/delete Delete Model
OllamaAPI DeleteModelOllamaApiDeleteUrlIdxDelete Delete /ollama/api/delete/{url_idx} Delete Model
OllamaAPI DownloadModelOllamaModelsDownloadPost Post /ollama/models/download Download Model
OllamaAPI DownloadModelOllamaModelsDownloadUrlIdxPost Post /ollama/models/download/{url_idx} Download Model
OllamaAPI EmbedOllamaApiEmbedPost Post /ollama/api/embed Embed
OllamaAPI EmbedOllamaApiEmbedUrlIdxPost Post /ollama/api/embed/{url_idx} Embed
OllamaAPI EmbeddingsOllamaApiEmbeddingsPost Post /ollama/api/embeddings Embeddings
OllamaAPI EmbeddingsOllamaApiEmbeddingsUrlIdxPost Post /ollama/api/embeddings/{url_idx} Embeddings
OllamaAPI GenerateChatCompletionOllamaApiChatPost Post /ollama/api/chat Generate Chat Completion
OllamaAPI GenerateChatCompletionOllamaApiChatUrlIdxPost Post /ollama/api/chat/{url_idx} Generate Chat Completion
OllamaAPI GenerateCompletionOllamaApiGeneratePost Post /ollama/api/generate Generate Completion
OllamaAPI GenerateCompletionOllamaApiGenerateUrlIdxPost Post /ollama/api/generate/{url_idx} Generate Completion
OllamaAPI GenerateOpenaiChatCompletionOllamaV1ChatCompletionsPost Post /ollama/v1/chat/completions Generate Openai Chat Completion
OllamaAPI GenerateOpenaiChatCompletionOllamaV1ChatCompletionsUrlIdxPost Post /ollama/v1/chat/completions/{url_idx} Generate Openai Chat Completion
OllamaAPI GenerateOpenaiCompletionOllamaV1CompletionsPost Post /ollama/v1/completions Generate Openai Completion
OllamaAPI GenerateOpenaiCompletionOllamaV1CompletionsUrlIdxPost Post /ollama/v1/completions/{url_idx} Generate Openai Completion
OllamaAPI GetConfigOllamaConfigGet Get /ollama/config Get Config
OllamaAPI GetOllamaLoadedModelsOllamaApiPsGet Get /ollama/api/ps Get Ollama Loaded Models
OllamaAPI GetOllamaTagsOllamaApiTagsGet Get /ollama/api/tags Get Ollama Tags
OllamaAPI GetOllamaTagsOllamaApiTagsUrlIdxGet Get /ollama/api/tags/{url_idx} Get Ollama Tags
OllamaAPI GetOllamaVersionsOllamaApiVersionGet Get /ollama/api/version Get Ollama Versions
OllamaAPI GetOllamaVersionsOllamaApiVersionUrlIdxGet Get /ollama/api/version/{url_idx} Get Ollama Versions
OllamaAPI GetOpenaiModelsOllamaV1ModelsGet Get /ollama/v1/models Get Openai Models
OllamaAPI GetOpenaiModelsOllamaV1ModelsUrlIdxGet Get /ollama/v1/models/{url_idx} Get Openai Models
OllamaAPI GetStatusOllamaGet Get /ollama/ Get Status
OllamaAPI GetStatusOllamaHead Head /ollama/ Get Status
OllamaAPI PullModelOllamaApiPullPost Post /ollama/api/pull Pull Model
OllamaAPI PullModelOllamaApiPullUrlIdxPost Post /ollama/api/pull/{url_idx} Pull Model
OllamaAPI PushModelOllamaApiPushDelete Delete /ollama/api/push Push Model
OllamaAPI PushModelOllamaApiPushUrlIdxDelete Delete /ollama/api/push/{url_idx} Push Model
OllamaAPI ShowModelInfoOllamaApiShowPost Post /ollama/api/show Show Model Info
OllamaAPI UnloadModelOllamaApiUnloadPost Post /ollama/api/unload Unload Model
OllamaAPI UpdateConfigOllamaConfigUpdatePost Post /ollama/config/update Update Config
OllamaAPI UploadModelOllamaModelsUploadPost Post /ollama/models/upload Upload Model
OllamaAPI UploadModelOllamaModelsUploadUrlIdxPost Post /ollama/models/upload/{url_idx} Upload Model
OllamaAPI VerifyConnectionOllamaVerifyPost Post /ollama/verify Verify Connection
OpenaiAPI GenerateChatCompletionOpenaiChatCompletionsPost Post /openai/chat/completions Generate Chat Completion
OpenaiAPI GetConfigOpenaiConfigGet Get /openai/config Get Config
OpenaiAPI GetModelsOpenaiModelsGet Get /openai/models Get Models
OpenaiAPI GetModelsOpenaiModelsUrlIdxGet Get /openai/models/{url_idx} Get Models
OpenaiAPI ProxyOpenaiPathDelete Get /openai/{path} Proxy
OpenaiAPI ProxyOpenaiPathDelete_0 Put /openai/{path} Proxy
OpenaiAPI ProxyOpenaiPathDelete_1 Post /openai/{path} Proxy
OpenaiAPI ProxyOpenaiPathDelete_2 Delete /openai/{path} Proxy
OpenaiAPI SpeechOpenaiAudioSpeechPost Post /openai/audio/speech Speech
OpenaiAPI UpdateConfigOpenaiConfigUpdatePost Post /openai/config/update Update Config
OpenaiAPI VerifyConnectionOpenaiVerifyPost Post /openai/verify Verify Connection
PipelinesAPI AddPipelineApiV1PipelinesAddPost Post /api/v1/pipelines/add Add Pipeline
PipelinesAPI DeletePipelineApiV1PipelinesDeleteDelete Delete /api/v1/pipelines/delete Delete Pipeline
PipelinesAPI GetPipelineValvesApiV1PipelinesPipelineIdValvesGet Get /api/v1/pipelines/{pipeline_id}/valves Get Pipeline Valves
PipelinesAPI GetPipelineValvesSpecApiV1PipelinesPipelineIdValvesSpecGet Get /api/v1/pipelines/{pipeline_id}/valves/spec Get Pipeline Valves Spec
PipelinesAPI GetPipelinesApiV1PipelinesGet Get /api/v1/pipelines/ Get Pipelines
PipelinesAPI GetPipelinesListApiV1PipelinesListGet Get /api/v1/pipelines/list Get Pipelines List
PipelinesAPI UpdatePipelineValvesApiV1PipelinesPipelineIdValvesUpdatePost Post /api/v1/pipelines/{pipeline_id}/valves/update Update Pipeline Valves
PipelinesAPI UploadPipelineApiV1PipelinesUploadPost Post /api/v1/pipelines/upload Upload Pipeline
PromptsAPI CreateNewPromptApiV1PromptsCreatePost Post /api/v1/prompts/create Create New Prompt
PromptsAPI DeletePromptByCommandApiV1PromptsCommandCommandDeleteDelete Delete /api/v1/prompts/command/{command}/delete Delete Prompt By Command
PromptsAPI GetPromptByCommandApiV1PromptsCommandCommandGet Get /api/v1/prompts/command/{command} Get Prompt By Command
PromptsAPI GetPromptListApiV1PromptsListGet Get /api/v1/prompts/list Get Prompt List
PromptsAPI GetPromptsApiV1PromptsGet Get /api/v1/prompts/ Get Prompts
PromptsAPI UpdatePromptByCommandApiV1PromptsCommandCommandUpdatePost Post /api/v1/prompts/command/{command}/update Update Prompt By Command
RetrievalAPI DeleteEntriesFromCollectionApiV1RetrievalDeletePost Post /api/v1/retrieval/delete Delete Entries From Collection
RetrievalAPI GetEmbeddingConfigApiV1RetrievalEmbeddingGet Get /api/v1/retrieval/embedding Get Embedding Config
RetrievalAPI GetEmbeddingsApiV1RetrievalEfTextGet Get /api/v1/retrieval/ef/{text} Get Embeddings
RetrievalAPI GetRagConfigApiV1RetrievalConfigGet Get /api/v1/retrieval/config Get Rag Config
RetrievalAPI GetStatusApiV1RetrievalGet Get /api/v1/retrieval/ Get Status
RetrievalAPI ProcessFileApiV1RetrievalProcessFilePost Post /api/v1/retrieval/process/file Process File
RetrievalAPI ProcessFilesBatchApiV1RetrievalProcessFilesBatchPost Post /api/v1/retrieval/process/files/batch Process Files Batch
RetrievalAPI ProcessTextApiV1RetrievalProcessTextPost Post /api/v1/retrieval/process/text Process Text
RetrievalAPI ProcessWebApiV1RetrievalProcessWebPost Post /api/v1/retrieval/process/web Process Web
RetrievalAPI ProcessWebSearchApiV1RetrievalProcessWebSearchPost Post /api/v1/retrieval/process/web/search Process Web Search
RetrievalAPI ProcessYoutubeVideoApiV1RetrievalProcessYoutubePost Post /api/v1/retrieval/process/youtube Process Youtube Video
RetrievalAPI QueryCollectionHandlerApiV1RetrievalQueryCollectionPost Post /api/v1/retrieval/query/collection Query Collection Handler
RetrievalAPI QueryDocHandlerApiV1RetrievalQueryDocPost Post /api/v1/retrieval/query/doc Query Doc Handler
RetrievalAPI ResetUploadDirApiV1RetrievalResetUploadsPost Post /api/v1/retrieval/reset/uploads Reset Upload Dir
RetrievalAPI ResetVectorDbApiV1RetrievalResetDbPost Post /api/v1/retrieval/reset/db Reset Vector Db
RetrievalAPI UpdateEmbeddingConfigApiV1RetrievalEmbeddingUpdatePost Post /api/v1/retrieval/embedding/update Update Embedding Config
RetrievalAPI UpdateRagConfigApiV1RetrievalConfigUpdatePost Post /api/v1/retrieval/config/update Update Rag Config
TasksAPI GenerateAutocompletionApiV1TasksAutoCompletionsPost Post /api/v1/tasks/auto/completions Generate Autocompletion
TasksAPI GenerateChatTagsApiV1TasksTagsCompletionsPost Post /api/v1/tasks/tags/completions Generate Chat Tags
TasksAPI GenerateEmojiApiV1TasksEmojiCompletionsPost Post /api/v1/tasks/emoji/completions Generate Emoji
TasksAPI GenerateFollowUpsApiV1TasksFollowUpCompletionsPost Post /api/v1/tasks/follow_up/completions Generate Follow Ups
TasksAPI GenerateImagePromptApiV1TasksImagePromptCompletionsPost Post /api/v1/tasks/image_prompt/completions Generate Image Prompt
TasksAPI GenerateMoaResponseApiV1TasksMoaCompletionsPost Post /api/v1/tasks/moa/completions Generate Moa Response
TasksAPI GenerateQueriesApiV1TasksQueriesCompletionsPost Post /api/v1/tasks/queries/completions Generate Queries
TasksAPI GenerateTitleApiV1TasksTitleCompletionsPost Post /api/v1/tasks/title/completions Generate Title
TasksAPI GetTaskConfigApiV1TasksConfigGet Get /api/v1/tasks/config Get Task Config
TasksAPI UpdateTaskConfigApiV1TasksConfigUpdatePost Post /api/v1/tasks/config/update Update Task Config
ToolsAPI CreateNewToolsApiV1ToolsCreatePost Post /api/v1/tools/create Create New Tools
ToolsAPI DeleteToolsByIdApiV1ToolsIdIdDeleteDelete Delete /api/v1/tools/id/{id}/delete Delete Tools By Id
ToolsAPI ExportToolsApiV1ToolsExportGet Get /api/v1/tools/export Export Tools
ToolsAPI GetToolListApiV1ToolsListGet Get /api/v1/tools/list Get Tool List
ToolsAPI GetToolsApiV1ToolsGet Get /api/v1/tools/ Get Tools
ToolsAPI GetToolsByIdApiV1ToolsIdIdGet Get /api/v1/tools/id/{id} Get Tools By Id
ToolsAPI GetToolsUserValvesByIdApiV1ToolsIdIdValvesUserGet Get /api/v1/tools/id/{id}/valves/user Get Tools User Valves By Id
ToolsAPI GetToolsUserValvesSpecByIdApiV1ToolsIdIdValvesUserSpecGet Get /api/v1/tools/id/{id}/valves/user/spec Get Tools User Valves Spec By Id
ToolsAPI GetToolsValvesByIdApiV1ToolsIdIdValvesGet Get /api/v1/tools/id/{id}/valves Get Tools Valves By Id
ToolsAPI GetToolsValvesSpecByIdApiV1ToolsIdIdValvesSpecGet Get /api/v1/tools/id/{id}/valves/spec Get Tools Valves Spec By Id
ToolsAPI LoadToolFromUrlApiV1ToolsLoadUrlPost Post /api/v1/tools/load/url Load Tool From Url
ToolsAPI UpdateToolsByIdApiV1ToolsIdIdUpdatePost Post /api/v1/tools/id/{id}/update Update Tools By Id
ToolsAPI UpdateToolsUserValvesByIdApiV1ToolsIdIdValvesUserUpdatePost Post /api/v1/tools/id/{id}/valves/user/update Update Tools User Valves By Id
ToolsAPI UpdateToolsValvesByIdApiV1ToolsIdIdValvesUpdatePost Post /api/v1/tools/id/{id}/valves/update Update Tools Valves By Id
UsersAPI DeleteUserByIdApiV1UsersUserIdDelete Delete /api/v1/users/{user_id} Delete User By Id
UsersAPI GetActiveUsersApiV1UsersActiveGet Get /api/v1/users/active Get Active Users
UsersAPI GetAllUsersApiV1UsersAllGet Get /api/v1/users/all Get All Users
UsersAPI GetDefaultUserPermissionsApiV1UsersDefaultPermissionsGet Get /api/v1/users/default/permissions Get Default User Permissions
UsersAPI GetUserActiveStatusByIdApiV1UsersUserIdActiveGet Get /api/v1/users/{user_id}/active Get User Active Status By Id
UsersAPI GetUserByIdApiV1UsersUserIdGet Get /api/v1/users/{user_id} Get User By Id
UsersAPI GetUserGroupsApiV1UsersGroupsGet Get /api/v1/users/groups Get User Groups
UsersAPI GetUserInfoBySessionUserApiV1UsersUserInfoGet Get /api/v1/users/user/info Get User Info By Session User
UsersAPI GetUserPermissisionsApiV1UsersPermissionsGet Get /api/v1/users/permissions Get User Permissisions
UsersAPI GetUserSettingsBySessionUserApiV1UsersUserSettingsGet Get /api/v1/users/user/settings Get User Settings By Session User
UsersAPI GetUsersApiV1UsersGet Get /api/v1/users/ Get Users
UsersAPI UpdateDefaultUserPermissionsApiV1UsersDefaultPermissionsPost Post /api/v1/users/default/permissions Update Default User Permissions
UsersAPI UpdateUserByIdApiV1UsersUserIdUpdatePost Post /api/v1/users/{user_id}/update Update User By Id
UsersAPI UpdateUserInfoBySessionUserApiV1UsersUserInfoUpdatePost Post /api/v1/users/user/info/update Update User Info By Session User
UsersAPI UpdateUserSettingsBySessionUserApiV1UsersUserSettingsUpdatePost Post /api/v1/users/user/settings/update Update User Settings By Session User
UtilsAPI DownloadChatAsPdfApiV1UtilsPdfPost Post /api/v1/utils/pdf Download Chat As Pdf
UtilsAPI DownloadDbApiV1UtilsDbDownloadGet Get /api/v1/utils/db/download Download Db
UtilsAPI DownloadLitellmConfigYamlApiV1UtilsLitellmConfigGet Get /api/v1/utils/litellm/config Download Litellm Config Yaml
UtilsAPI ExecuteCodeApiV1UtilsCodeExecutePost Post /api/v1/utils/code/execute Execute Code
UtilsAPI FormatCodeApiV1UtilsCodeFormatPost Post /api/v1/utils/code/format Format Code
UtilsAPI GetGravatarApiV1UtilsGravatarGet Get /api/v1/utils/gravatar Get Gravatar
UtilsAPI GetHtmlFromMarkdownApiV1UtilsMarkdownPost Post /api/v1/utils/markdown Get Html From Markdown

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), openwebui.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

Contributors

SchSeba

Issues