[Request]: New API Endpoint - Post Control Type to Get Filtered Data

[altoiddealer]

Is there an existing issue for this?

• I have searched the existing issues and checked the recent builds/commits of both this extension and the webui

What happened?

As of this writing, the ControlNet API endpoints are few and barely helpful.

POST Detect is probably the most useful, and I don't have any use for it.

• You can get a model list, likely a crap ton of them.
• You can get the module list, again likely a crap ton of them.
  ....The thought of filtering these lists on the user end is absurd.

The ControlNet script has those amazing functions for filtering the data in the UI, based simply on "Control Type" and checking the current SD Model.

It would be super duper awesome to be able to get a dictionary response containing all that filtered data via API request!!

Glorious filtered data... I want you so badly via API

Steps to reproduce the problem

• Create a script that uses SD WebUI via API
• Add ControlNet integrations
• Cry

What should have happened?

An API endpoint to get that juicy filtered data would be freakin' sweet.

Commit where the problem happens

webui: Current
controlnet: Current

What browsers do you use to access the UI ?

No response

Command Line Arguments

No

List of enabled extensions

ControlNet

Console logs

None required

Additional information

No response

[huchenlei]

We already have /controlnet/control_types API endpoint to return the filtered preprocessor/models.

models are futher filtered by the active SD version. You can obtain SD version from existing A1111 API.

Revelant code:

sd-webui-controlnet/scripts/api.py

Lines 70 to 92 in 22f63dc

	@app.get("/controlnet/control_types")
	async def control_types():
	def format_control_type(
	filtered_preprocessor_list,
	filtered_model_list,
	default_option,
	default_model,
	):
	return {
	"module_list": filtered_preprocessor_list,
	"model_list": filtered_model_list,
	"default_option": default_option,
	"default_model": default_model,
	}
	return {
	"control_types": {
	control_type: format_control_type(
	*global_state.select_control_type(control_type)
	)
	for control_type in Preprocessor.get_all_preprocessor_tags()
	}
	}

[altoiddealer]

We already have /controlnet/control_types API endpoint to return the filtered preprocessor/models.

models are futher filtered by the active SD version. You can obtain SD version from existing A1111 API.

Revelant code:

sd-webui-controlnet/scripts/api.py

Lines 70 to 92 in 22f63dc

	@app.get("/controlnet/control_types")
	async def control_types():
	def format_control_type(
	filtered_preprocessor_list,
	filtered_model_list,
	default_option,
	default_model,
	):
	return {
	"module_list": filtered_preprocessor_list,
	"model_list": filtered_model_list,
	"default_option": default_option,
	"default_model": default_model,
	}
	return {
	"control_types": {
	control_type: format_control_type(
	*global_state.select_control_type(control_type)
	)
	for control_type in Preprocessor.get_all_preprocessor_tags()
	}
	}

At first I thought you were pulling my leg, but you are 100% correct. Hot damn that is amazing!

This is a colossal blunder by sd-webui-forge - I made this report because I thought ControlNet lacked such an API endpoint.

...Wrong! Only Forge is missing it. SMH.

This is immensely useful. Such a shame that Forge doesn't have it.

[altoiddealer]

@huchenlei proud to say, I actually made this happen.

I consider myself a bottom tier coder, but after a crap ton of guess-and-check and asking ChatGPT for help I managed to do this thing.

Now, hopefully Forge merges this.