Response for fetching public retriever configuration (for UI rendering). This is what the public frontend (mxp.co/r/{name}) fetches to render the search interface. It includes everything needed for UI rendering. Note: API keys are no longer required. The execute endpoint can be called without authentication - rate limiting and optional password protection provide security.
| Name | Type | Description | Notes |
|---|---|---|---|
| public_name | str | Public name of the retriever | |
| public_api_key | str | DEPRECATED: API keys are no longer required for public access. The execute endpoint can be called without authentication. | [optional] |
| display_config | DisplayConfigOutput | Display configuration for rendering the UI. Includes inputs, theme, layout, and exposed fields. | |
| password_protected | bool | Whether this retriever requires password authentication | |
| retriever_metadata | RetrieverMetadata | OPTIONAL. Technical metadata about how the retriever works. Only present if include_metadata=True was set during publishing. | [optional] |
from mixpeek.models.public_retriever_config_response import PublicRetrieverConfigResponse
# TODO update the JSON string below
json = "{}"
# create an instance of PublicRetrieverConfigResponse from a JSON string
public_retriever_config_response_instance = PublicRetrieverConfigResponse.from_json(json)
# print the JSON string representation of the object
print(PublicRetrieverConfigResponse.to_json())
# convert the object into a dict
public_retriever_config_response_dict = public_retriever_config_response_instance.to_dict()
# create an instance of PublicRetrieverConfigResponse from a dict
public_retriever_config_response_from_dict = PublicRetrieverConfigResponse.from_dict(public_retriever_config_response_dict)