SwarmUI API Documentation - BasicAPIFeatures

This is a subset of the API docs, see /docs/API.md for general info.

Basic general API routes, primarily for users and session handling.

HTTP Route AddNewPreset
HTTP Route ChangePassword
HTTP Route ChangeUserSettings
HTTP Route DeletePreset
HTTP Route DuplicatePreset
HTTP Route GetAPIKeyStatus
HTTP Route GetCurrentStatus
HTTP Route GetLanguage
HTTP Route GetMyUserData
HTTP Route GetNewSession
HTTP Route GetUserSettings
WebSocket Route InstallConfirmWS
HTTP Route InterruptAll
HTTP Route Login
HTTP Route Logout
HTTP Route ServerDebugMessage
HTTP Route SetAPIKey
HTTP Route SetParamEdits
HTTP Route SetStarredModels

HTTP Route /API/AddNewPreset

Description

User route to add a new parameter preset.

Permission Flag

manage_presets - Manage Presets in group User

Parameters

Name	Type	Description	Default
title	String	Name of the new preset.	(REQUIRED)
description	String	User-facing description text.	(REQUIRED)
raw	JObject	Use 'param_map' key to send the raw parameter mapping, equivalent to GenerateText2Image.	(REQUIRED)
preview_image	String	Optional preview image data base64 string.	(null)
is_edit	Boolean	If true, edit an existing preset. If false, do not override pre-existing presets of the same name.	`False`
editing	String	If is_edit is set, include the original preset name here.	(null)

Return Format

    "success": true
    // or:
    "preset_fail": "Some friendly error text here"

HTTP Route /API/ChangePassword

Warning

This API is marked non-final. This means it is experimental, non-functional, or subject to change. Use at your own risk.

Description

User route to change their own password. Has a ratelimit built in.

Permission Flag

edit_user_settings - Edit User Settings in group User

Parameters

Name	Type	Description	Default
oldPassword	String	Your current password.	(REQUIRED)
newPassword	String	Your new password. Must be at least 8 characters.	(REQUIRED)

Return Format

    "success": true

HTTP Route /API/ChangeUserSettings

Description

User route to change user settings data.

Permission Flag

edit_user_settings - Edit User Settings in group User

Parameters

Name	Type	Description	Default
rawData	JObject	Simple object map of key as setting ID to new setting value to apply, under 'settings'.	(REQUIRED)

Return Format

    "success": true

HTTP Route /API/DeletePreset

Description

User route to delete a preset.

Permission Flag

manage_presets - Manage Presets in group User

Parameters

Name	Type	Description	Default
preset	String	Name of the preset to delete.	(REQUIRED)

Return Format

    "success": true

HTTP Route /API/DuplicatePreset

Description

User route to duplicate an existing preset.

Permission Flag

manage_presets - Manage Presets in group User

Parameters

Name	Type	Description	Default
preset	String	Name of the preset to duplicate.	(REQUIRED)

Return Format

    "success": true

HTTP Route /API/GetAPIKeyStatus

Description

User route to get the current status of a given API key.

Permission Flag

read_user_settings - Read User Settings in group User

Parameters

Name	Type	Description	Default
keyType	String	The key type ID, eg 'stability_api'.	(REQUIRED)

Return Format

    "status": "last updated 2025-01-01 01:01" // or "not set"

HTTP Route /API/GetCurrentStatus

Description

Get current waiting generation count, model loading count, etc.

Permission Flag

fundamental_generate_tab_access - Fundamental Generate Tab Access in group User

Parameters

None.

Return Format

    "status": {
        "waiting_gens": 0,
        "loading_models": 0,
        "waiting_backends": 0,
        "live_gens": 0
    },
    "backend_status": {
        "status": "running", // "idle", "unknown", "disabled", "loading", "running", "some_loading", "errored", "all_disabled", "empty"
        "class": "", // "error", "warn", "soft", ""
        "message": "", // User-facing English text
        "any_loading": false
    },
    "supported_features": ["feature_id1", "feature_id2"]

HTTP Route /API/GetLanguage

Description

Get the details of a given language file.

Permission Flag

fundamental_generate_tab_access - Fundamental Generate Tab Access in group User

Parameters

Name	Type	Description	Default
language	String	The language ID, eg 'en'.	(REQUIRED)

Return Format

    "language": {
        "code": "en",
        "name": "English",
        "local_name": "English",
        "keys": {
            "key": "value"
        }
    }

HTTP Route /API/GetMyUserData

Description

User route to get the user's own base data.

Permission Flag

fundamental_generate_tab_access - Fundamental Generate Tab Access in group User

Parameters

None.

Return Format

    "user_name": "username",
    "presets": [
        {
            "author": "username",
            "title": "Preset Title",
            "description": "Preset Description",
            "param_map": {
                "key": "value"
            },
            "preview_image": "data:base64 img"
        }
    ],
    "language": "en",
    "permissions": ["permission1", "permission2"],
    "starred_models": {
        "LoRA": ["one", "two"]
    },
    "autocompletions": ["Word\nword\ntag\n3"]

HTTP Route /API/GetNewSession

Description

Special route to create a new session ID. Must be called before any other API route. Also returns other fundamental user and server data. Intentionally no permission flag required, as permissions are not defined until you create a session.

Permission Flag

(MISSING)

Parameters

None.

Return Format

    "session_id": "session_id",
    "user_id": "username",
    "output_append_user": true,
    "version": "1.2.3",
    "server_id": "abc123",
    "permissions": ["permission1", "permission2"]

HTTP Route /API/GetUserSettings

Description

Gets the user's current settings.

Permission Flag

read_user_settings - Read User Settings in group User

Parameters

None.

Return Format

    "themes": {
        "theme_id": {
            "name": "Theme Name",
            "is_dark": true,
            "css_paths": ["path1", "path2"]
        }
    },
    "settings": {
        "setting_id": "value"
    }

WebSocket Route /API/InstallConfirmWS

Description

Websocket route for the initial installation from the UI.

Permission Flag

install - Install in group Admin

Parameters

Name	Type	Description	Default
theme	String	Selected user theme.	(REQUIRED)
installed_for	String	Selected install_for (network mode choice) value.	(REQUIRED)
backend	String	Selected backend (comfy/none).	(REQUIRED)
models	String	Selected models to predownload.	(REQUIRED)
install_amd	Boolean	If true, install with AMD GPU compatibility.	(REQUIRED)
language	String	Selected user language.	(REQUIRED)
make_shortcut	Boolean	If true, make a Desktop shortcut.	`False`

Return Format

    // ... (do not automate calls to this)

HTTP Route /API/InterruptAll

Description

Tell all waiting generations in this session or all sessions to interrupt.

Permission Flag

basic_image_generation - Basic Image Generation in group User

Parameters

Name	Type	Description	Default
other_sessions	Boolean	If true, generations from all this user's sessions will be closed (ie even from other web page tabs or API usages). If false, only the current session is interrupted.	`False`

Return Format

    "success": true

HTTP Route /API/Login

Warning

This API is marked non-final. This means it is experimental, non-functional, or subject to change. Use at your own risk.

Description

Special route to log in as a user account. Generally only for UI users, bots/automated API usages should have a user account generate a token first.

Permission Flag

(MISSING)

Parameters

Name	Type	Description	Default
username	String	Login username.	(REQUIRED)
password	String	Login password.	(REQUIRED)

Return Format

    "success": "true" // and sets a cookie
    // or
    "error_id": "invalid_login" // or "ratelimit"

HTTP Route /API/Logout

Warning

This API is marked non-final. This means it is experimental, non-functional, or subject to change. Use at your own risk.

Description

Causes a user to log out, closing all assocated sessions in the process.

Permission Flag

fundamental - Fundamental in group User

Parameters

None.

Return Format

    "success": "true"

HTTP Route /API/ServerDebugMessage

Description

Send a debug message to server logs.

Permission Flag

server_debug_message - Server Debug Message in group Admin

Parameters

Name	Type	Description	Default
message	String	The message to log.	(REQUIRED)

Return Format

    "success": true

HTTP Route /API/SetAPIKey

Description

User route to set an API key.

Permission Flag

edit_user_settings - Edit User Settings in group User

Parameters

Name	Type	Description	Default
keyType	String	The key type ID, eg 'stability_api'.	(REQUIRED)
key	String	The new value of the key, or 'none' to unset.	(REQUIRED)

Return Format

    "success": true

HTTP Route /API/SetParamEdits

Description

UI internal helper for user customization of parameters.

Permission Flag

edit_params - Edit Params in group User

Parameters

Name	Type	Description	Default
rawData	JObject	Blob of parameter edit data.	(REQUIRED)

Return Format

    "success": true

HTTP Route /API/SetStarredModels

Description

User route to update the user's starred models lists.

Permission Flag

fundamental_model_access - Fundamental Model Access in group User

Parameters

Name	Type	Description	Default
raw	JObject	Send the raw data as eg 'LoRA': ['one', 'two'], 'Stable-Diffusion': [ ... ]	(REQUIRED)

Return Format

    "success": true

Uh oh!

FilesExpand file tree

BasicAPIFeatures.md

Latest commit

History

BasicAPIFeatures.md

File metadata and controls

SwarmUI API Documentation - BasicAPIFeatures

Table of Contents:

HTTP Route /API/AddNewPreset

Description

Permission Flag

Parameters

Return Format

HTTP Route /API/ChangePassword

Description

Permission Flag

Parameters

Return Format

HTTP Route /API/ChangeUserSettings

Description

Permission Flag

Parameters

Return Format

HTTP Route /API/DeletePreset

Description

Permission Flag

Parameters

Return Format

HTTP Route /API/DuplicatePreset

Description

Permission Flag

Parameters

Return Format

HTTP Route /API/GetAPIKeyStatus

Description

Permission Flag

Parameters

Return Format

HTTP Route /API/GetCurrentStatus

Description

Permission Flag

Parameters

Return Format

HTTP Route /API/GetLanguage

Description

Permission Flag

Parameters

Return Format

HTTP Route /API/GetMyUserData

Description

Permission Flag

Parameters

Return Format

HTTP Route /API/GetNewSession

Description

Permission Flag

Parameters

Return Format

HTTP Route /API/GetUserSettings

Description

Permission Flag

Parameters

Return Format

WebSocket Route /API/InstallConfirmWS

Description

Permission Flag

Parameters

Return Format

HTTP Route /API/InterruptAll

Description

Permission Flag

Parameters

Return Format

HTTP Route /API/Login

Description

Permission Flag

Parameters

Return Format

HTTP Route /API/Logout