Actions304
- Any Actions
- get_models_api_models_get
- get_base_models_api_models_base_get
- chat_completion_api_chat_completions_post
- chat_completed_api_chat_completed_post
- chat_action_api_chat_actions__action_id__post
- stop_task_endpoint_api_tasks_stop__task_id__post
- list_tasks_endpoint_api_tasks_get
- get_app_config_api_config_get
- get_webhook_url_api_webhook_get
- update_webhook_url_api_webhook_post
- get_app_version_api_version_get
- get_app_latest_release_version_api_version_updates_get
- get_app_changelog_api_changelog_get
- oauth_login_oauth__provider__login_get
- oauth_callback_oauth__provider__callback_get
- get_manifest_json_manifest_json_get
- get_opensearch_xml_opensearch_xml_get
- healthcheck_health_get
- healthcheck_with_db_health_db_get
- Ollama Actions
- get_status_ollama__get
- get_status_ollama__head
- verify_connection_ollama_verify_post
- get_config_ollama_config_get
- update_config_ollama_config_update_post
- get_ollama_tags_ollama_api_tags__url_idx__get
- get_ollama_tags_ollama_api_tags_get
- get_ollama_versions_ollama_api_version__url_idx__get
- get_ollama_versions_ollama_api_version_get
- get_ollama_loaded_models_ollama_api_ps_get
- pull_model_ollama_api_pull__url_idx__post
- pull_model_ollama_api_pull_post
- push_model_ollama_api_push__url_idx__delete
- push_model_ollama_api_push_delete
- create_model_ollama_api_create__url_idx__post
- create_model_ollama_api_create_post
- copy_model_ollama_api_copy__url_idx__post
- copy_model_ollama_api_copy_post
- delete_model_ollama_api_delete__url_idx__delete
- delete_model_ollama_api_delete_delete
- show_model_info_ollama_api_show_post
- embed_ollama_api_embed__url_idx__post
- embed_ollama_api_embed_post
- embeddings_ollama_api_embeddings__url_idx__post
- embeddings_ollama_api_embeddings_post
- generate_completion_ollama_api_generate__url_idx__post
- generate_completion_ollama_api_generate_post
- generate_chat_completion_ollama_api_chat__url_idx__post
- generate_chat_completion_ollama_api_chat_post
- generate_openai_completion_ollama_v1_completions__url_idx__post
- generate_openai_completion_ollama_v1_completions_post
- generate_openai_chat_completion_ollama_v1_chat_completions__url_idx__post
- generate_openai_chat_completion_ollama_v1_chat_completions_post
- get_openai_models_ollama_v1_models__url_idx__get
- get_openai_models_ollama_v1_models_get
- download_model_ollama_models_download__url_idx__post
- download_model_ollama_models_download_post
- upload_model_ollama_models_upload__url_idx__post
- upload_model_ollama_models_upload_post
- Openai Actions
- Pipelines Actions
- get_pipelines_list_api_v1_pipelines_list_get
- upload_pipeline_api_v1_pipelines_upload_post
- add_pipeline_api_v1_pipelines_add_post
- delete_pipeline_api_v1_pipelines_delete_delete
- get_pipelines_api_v1_pipelines__get
- get_pipeline_valves_api_v1_pipelines__pipeline_id__valves_get
- get_pipeline_valves_spec_api_v1_pipelines__pipeline_id__valves_spec_get
- update_pipeline_valves_api_v1_pipelines__pipeline_id__valves_update_post
- Tasks Actions
- get_task_config_api_v1_tasks_config_get
- update_task_config_api_v1_tasks_config_update_post
- generate_title_api_v1_tasks_title_completions_post
- generate_chat_tags_api_v1_tasks_tags_completions_post
- generate_image_prompt_api_v1_tasks_image_prompt_completions_post
- generate_queries_api_v1_tasks_queries_completions_post
- generate_autocompletion_api_v1_tasks_auto_completions_post
- generate_emoji_api_v1_tasks_emoji_completions_post
- generate_moa_response_api_v1_tasks_moa_completions_post
- Images Actions
- get_config_api_v1_images_config_get
- update_config_api_v1_images_config_update_post
- verify_url_api_v1_images_config_url_verify_get
- get_image_config_api_v1_images_image_config_get
- update_image_config_api_v1_images_image_config_update_post
- get_models_api_v1_images_models_get
- image_generations_api_v1_images_generations_post
- Audio Actions
- Retrieval Actions
- get_status_api_v1_retrieval__get
- get_embedding_config_api_v1_retrieval_embedding_get
- get_reraanking_config_api_v1_retrieval_reranking_get
- update_embedding_config_api_v1_retrieval_embedding_update_post
- update_reranking_config_api_v1_retrieval_reranking_update_post
- get_rag_config_api_v1_retrieval_config_get
- update_rag_config_api_v1_retrieval_config_update_post
- get_rag_template_api_v1_retrieval_template_get
- get_query_settings_api_v1_retrieval_query_settings_get
- update_query_settings_api_v1_retrieval_query_settings_update_post
- process_file_api_v1_retrieval_process_file_post
- process_text_api_v1_retrieval_process_text_post
- process_youtube_video_api_v1_retrieval_process_youtube_post
- process_web_api_v1_retrieval_process_web_post
- process_web_search_api_v1_retrieval_process_web_search_post
- query_doc_handler_api_v1_retrieval_query_doc_post
- query_collection_handler_api_v1_retrieval_query_collection_post
- delete_entries_from_collection_api_v1_retrieval_delete_post
- reset_vector_db_api_v1_retrieval_reset_db_post
- reset_upload_dir_api_v1_retrieval_reset_uploads_post
- get_embeddings_api_v1_retrieval_ef__text__get
- process_files_batch_api_v1_retrieval_process_files_batch_post
- Configs Actions
- import_config_api_v1_configs_import_post
- export_config_api_v1_configs_export_get
- get_direct_connections_config_api_v1_configs_direct_connections_get
- set_direct_connections_config_api_v1_configs_direct_connections_post
- get_code_interpreter_config_api_v1_configs_code_interpreter_get
- set_code_interpreter_config_api_v1_configs_code_interpreter_post
- get_models_config_api_v1_configs_models_get
- set_models_config_api_v1_configs_models_post
- set_default_suggestions_api_v1_configs_suggestions_post
- get_banners_api_v1_configs_banners_get
- set_banners_api_v1_configs_banners_post
- Auths Actions
- get_session_user_api_v1_auths__get
- update_profile_api_v1_auths_update_profile_post
- update_password_api_v1_auths_update_password_post
- ldap_auth_api_v1_auths_ldap_post
- signin_api_v1_auths_signin_post
- signup_api_v1_auths_signup_post
- signout_api_v1_auths_signout_get
- add_user_api_v1_auths_add_post
- get_admin_details_api_v1_auths_admin_details_get
- get_admin_config_api_v1_auths_admin_config_get
- update_admin_config_api_v1_auths_admin_config_post
- get_ldap_server_api_v1_auths_admin_config_ldap_server_get
- update_ldap_server_api_v1_auths_admin_config_ldap_server_post
- get_ldap_config_api_v1_auths_admin_config_ldap_get
- update_ldap_config_api_v1_auths_admin_config_ldap_post
- get_api_key_api_v1_auths_api_key_get
- generate_api_key_api_v1_auths_api_key_post
- delete_api_key_api_v1_auths_api_key_delete
- Users Actions
- get_users_api_v1_users__get
- get_user_groups_api_v1_users_groups_get
- get_user_permissisions_api_v1_users_permissions_get
- get_user_permissions_api_v1_users_default_permissions_get
- update_user_permissions_api_v1_users_default_permissions_post
- update_user_role_api_v1_users_update_role_post
- get_user_settings_by_session_user_api_v1_users_user_settings_get
- update_user_settings_by_session_user_api_v1_users_user_settings_update_post
- get_user_info_by_session_user_api_v1_users_user_info_get
- update_user_info_by_session_user_api_v1_users_user_info_update_post
- get_user_by_id_api_v1_users__user_id__get
- delete_user_by_id_api_v1_users__user_id__delete
- update_user_by_id_api_v1_users__user_id__update_post
- Channels Actions
- get_channels_api_v1_channels__get
- create_new_channel_api_v1_channels_create_post
- get_channel_by_id_api_v1_channels__id__get
- update_channel_by_id_api_v1_channels__id__update_post
- delete_channel_by_id_api_v1_channels__id__delete_delete
- get_channel_messages_api_v1_channels__id__messages_get
- post_new_message_api_v1_channels__id__messages_post_post
- get_channel_message_api_v1_channels__id__messages__message_id__get
- get_channel_thread_messages_api_v1_channels__id__messages__message_id__thread_get
- update_message_by_id_api_v1_channels__id__messages__message_id__update_post
- add_reaction_to_message_api_v1_channels__id__messages__message_id__reactions_add_post
- remove_reaction_by_id_and_user_id_and_name_api_v1_channels__id__messages__message_id__reactions_remove_post
- delete_message_by_id_api_v1_channels__id__messages__message_id__delete_delete
- Chats Actions
- get_session_user_chat_list_api_v1_chats_list_get
- get_session_user_chat_list_api_v1_chats__get
- delete_all_user_chats_api_v1_chats__delete
- get_user_chat_list_by_user_id_api_v1_chats_list_user__user_id__get
- create_new_chat_api_v1_chats_new_post
- import_chat_api_v1_chats_import_post
- search_user_chats_api_v1_chats_search_get
- get_chats_by_folder_id_api_v1_chats_folder__folder_id__get
- get_user_pinned_chats_api_v1_chats_pinned_get
- get_user_chats_api_v1_chats_all_get
- get_user_archived_chats_api_v1_chats_all_archived_get
- get_all_user_tags_api_v1_chats_all_tags_get
- get_all_user_chats_in_db_api_v1_chats_all_db_get
- get_archived_session_user_chat_list_api_v1_chats_archived_get
- archive_all_chats_api_v1_chats_archive_all_post
- get_shared_chat_by_id_api_v1_chats_share__share_id__get
- get_user_chat_list_by_tag_name_api_v1_chats_tags_post
- get_chat_by_id_api_v1_chats__id__get
- update_chat_by_id_api_v1_chats__id__post
- delete_chat_by_id_api_v1_chats__id__delete
- get_pinned_status_by_id_api_v1_chats__id__pinned_get
- pin_chat_by_id_api_v1_chats__id__pin_post
- clone_chat_by_id_api_v1_chats__id__clone_post
- clone_shared_chat_by_id_api_v1_chats__id__clone_shared_post
- archive_chat_by_id_api_v1_chats__id__archive_post
- share_chat_by_id_api_v1_chats__id__share_post
- delete_shared_chat_by_id_api_v1_chats__id__share_delete
- update_chat_folder_id_by_id_api_v1_chats__id__folder_post
- get_chat_tags_by_id_api_v1_chats__id__tags_get
- add_tag_by_id_and_tag_name_api_v1_chats__id__tags_post
- delete_tag_by_id_and_tag_name_api_v1_chats__id__tags_delete
- delete_all_tags_by_id_api_v1_chats__id__tags_all_delete
- Models Actions
- get_models_api_v1_models__get
- get_base_models_api_v1_models_base_get
- create_new_model_api_v1_models_create_post
- get_model_by_id_api_v1_models_model_get
- toggle_model_by_id_api_v1_models_model_toggle_post
- update_model_by_id_api_v1_models_model_update_post
- delete_model_by_id_api_v1_models_model_delete_delete
- delete_all_models_api_v1_models_delete_all_delete
- Knowledge Actions
- get_knowledge_api_v1_knowledge__get
- get_knowledge_list_api_v1_knowledge_list_get
- create_new_knowledge_api_v1_knowledge_create_post
- get_knowledge_by_id_api_v1_knowledge__id__get
- update_knowledge_by_id_api_v1_knowledge__id__update_post
- add_file_to_knowledge_by_id_api_v1_knowledge__id__file_add_post
- update_file_from_knowledge_by_id_api_v1_knowledge__id__file_update_post
- remove_file_from_knowledge_by_id_api_v1_knowledge__id__file_remove_post
- delete_knowledge_by_id_api_v1_knowledge__id__delete_delete
- reset_knowledge_by_id_api_v1_knowledge__id__reset_post
- add_files_to_knowledge_batch_api_v1_knowledge__id__files_batch_add_post
- Prompts Actions
- get_prompts_api_v1_prompts__get
- get_prompt_list_api_v1_prompts_list_get
- create_new_prompt_api_v1_prompts_create_post
- get_prompt_by_command_api_v1_prompts_command__command__get
- update_prompt_by_command_api_v1_prompts_command__command__update_post
- delete_prompt_by_command_api_v1_prompts_command__command__delete_delete
- Tools Actions
- get_tools_api_v1_tools__get
- get_tool_list_api_v1_tools_list_get
- export_tools_api_v1_tools_export_get
- create_new_tools_api_v1_tools_create_post
- get_tools_by_id_api_v1_tools_id__id__get
- update_tools_by_id_api_v1_tools_id__id__update_post
- delete_tools_by_id_api_v1_tools_id__id__delete_delete
- get_tools_valves_by_id_api_v1_tools_id__id__valves_get
- get_tools_valves_spec_by_id_api_v1_tools_id__id__valves_spec_get
- update_tools_valves_by_id_api_v1_tools_id__id__valves_update_post
- get_tools_user_valves_by_id_api_v1_tools_id__id__valves_user_get
- get_tools_user_valves_spec_by_id_api_v1_tools_id__id__valves_user_spec_get
- update_tools_user_valves_by_id_api_v1_tools_id__id__valves_user_update_post
- Memories Actions
- get_embeddings_api_v1_memories_ef_get
- get_memories_api_v1_memories__get
- add_memory_api_v1_memories_add_post
- query_memory_api_v1_memories_query_post
- reset_memory_from_vector_db_api_v1_memories_reset_post
- delete_memory_by_user_id_api_v1_memories_delete_user_delete
- update_memory_by_id_api_v1_memories__memory_id__update_post
- delete_memory_by_id_api_v1_memories__memory_id__delete
- Folders Actions
- get_folders_api_v1_folders__get
- create_folder_api_v1_folders__post
- get_folder_by_id_api_v1_folders__id__get
- delete_folder_by_id_api_v1_folders__id__delete
- update_folder_name_by_id_api_v1_folders__id__update_post
- update_folder_parent_id_by_id_api_v1_folders__id__update_parent_post
- update_folder_is_expanded_by_id_api_v1_folders__id__update_expanded_post
- Groups Actions
- Files Actions
- list_files_api_v1_files__get
- upload_file_api_v1_files__post
- delete_all_files_api_v1_files_all_delete
- get_file_by_id_api_v1_files__id__get
- delete_file_by_id_api_v1_files__id__delete
- get_file_data_content_by_id_api_v1_files__id__data_content_get
- update_file_data_content_by_id_api_v1_files__id__data_content_update_post
- get_file_content_by_id_api_v1_files__id__content_get
- get_html_file_content_by_id_api_v1_files__id__content_html_get
- get_file_content_by_id_api_v1_files__id__content__file_name__get
- Functions Actions
- get_functions_api_v1_functions__get
- get_functions_api_v1_functions_export_get
- create_new_function_api_v1_functions_create_post
- get_function_by_id_api_v1_functions_id__id__get
- toggle_function_by_id_api_v1_functions_id__id__toggle_post
- toggle_global_by_id_api_v1_functions_id__id__toggle_global_post
- update_function_by_id_api_v1_functions_id__id__update_post
- delete_function_by_id_api_v1_functions_id__id__delete_delete
- get_function_valves_by_id_api_v1_functions_id__id__valves_get
- get_function_valves_spec_by_id_api_v1_functions_id__id__valves_spec_get
- update_function_valves_by_id_api_v1_functions_id__id__valves_update_post
- get_function_user_valves_by_id_api_v1_functions_id__id__valves_user_get
- get_function_user_valves_spec_by_id_api_v1_functions_id__id__valves_user_spec_get
- update_function_user_valves_by_id_api_v1_functions_id__id__valves_user_update_post
- Evaluations Actions
- get_config_api_v1_evaluations_config_get
- update_config_api_v1_evaluations_config_post
- get_all_feedbacks_api_v1_evaluations_feedbacks_all_get
- delete_all_feedbacks_api_v1_evaluations_feedbacks_all_delete
- get_all_feedbacks_api_v1_evaluations_feedbacks_all_export_get
- get_feedbacks_api_v1_evaluations_feedbacks_user_get
- delete_feedbacks_api_v1_evaluations_feedbacks_delete
- create_feedback_api_v1_evaluations_feedback_post
- get_feedback_by_id_api_v1_evaluations_feedback__id__get
- update_feedback_by_id_api_v1_evaluations_feedback__id__post
- delete_feedback_by_id_api_v1_evaluations_feedback__id__delete
- Utils Actions
Auths → get_api_key_api_v1_auths_api_key_get
AI-generatedSummary
Retrieve API key authentication details from the Open Web UI service by sending a GET request to the /api/v1/auths/api_key endpoint.
Inputs
- Skip Authentication — Optionally bypass authentication for this request; defaults to false.
Output shape
A JSON object containing the API key authentication details retrieved from the Open Web UI service.
Authentication is required unless Skip Authentication is enabled. The request uses the base URL http://open-webui:8080 by default. Only the GET method is used for this operation.
Examples
Example 1: Retrieve current API key authentication info
Set skipAuthentication to false (or leave default). The node will authenticate with Open WebUI Auth credentials and perform a GET request to /api/v1/auths/api_key, returning the associated auth details.