Skip to content

Read image-edit server settings

GET
/admin/system/aiedit

Returns the saved MCP server name used for image variations. With no name saved, the field is left out and the response is {}.

You need system.config.read or system.admin for the whole install; a permission held only for a team doesn’t count. Without one you get 403, and signed-out callers get 401.

This is only the saved setting; it doesn’t show that the server exists, is enabled or can run the image-edit tool. New variation requests read this setting, but generation uses the name configured at startup, so after a change the two can differ until a restart. With an empty name, a new variation request that passes its other checks gets 409; work already submitted isn’t cancelled.

This read doesn’t contact any MCP server. A failure reading the settings gets a plain-text 500.

The saved image-edit server setting.

The saved MCP server name for image variations. New variation requests read it, while generation keeps the name configured at startup.

object
image_edit_server

The MCP server’s registration name, matched exactly when used. Saving checks only that it’s at most 200 bytes of UTF-8, not that the server is registered or its tool granted. Left out of responses when empty. On save, a missing, null or empty value clears it. Restart the app for generation to use a changed name.

string

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed