Open Web UI icon

Open Web UI

OpenWebUI

Actions304

Auths → generate_api_key_api_v1_auths_api_key_post

AI-generated

Summary

Generate a new API key by making a POST request to the /api/v1/auths/api_key endpoint of the Open Web UI service.

Inputs

  • Skip Authentication — Optional boolean to skip using Open Web UI authentication credentials for this request. Defaults to false.
  • Method (required) — HTTP method to use for the request; although this operation defaults to POST, it can be set to GET, HEAD, DELETE, or PUT as options.

Output shape

a JSON object containing the newly generated API key and related metadata as returned by the POST /api/v1/auths/api_key endpoint.

The operation uses the OpenWebUI Auth credentials unless 'Skip Authentication' is enabled. The base URL is fixed to http://open-webui:8080 and the request path is /api/v1/auths/api_key. The response will be the data provided by the Open Web UI service's API key generation endpoint.

Links

Discussion