Skip to content

Proxies API Reference

BaseProxy

lllm.proxies.base.BaseProxy

Base class for describing an API surface that agents can call as tools.

Source code in lllm/proxies/base.py 
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
class BaseProxy:
    """Base class for describing an API surface that agents can call as tools."""

    def __init__(
        self,
        *args,
        activate_proxies: Optional[List[str]] = None,
        cutoff_date: Optional[dt.datetime] = None,
        deploy_mode: bool = False,
        use_cache: bool = True,
        auto_discover: Optional[bool] = None,
        **kwargs,
    ):
        """
        Support both legacy signatures (cutoff_date, use_cache) and the newer keyword-driven one.
        """
        self.activate_proxies = activate_proxies[:] if activate_proxies else []
        self.cutoff_date = cutoff_date
        self.deploy_mode = deploy_mode
        self.use_cache = use_cache
        self.auto_discover = auto_discover

        legacy_args = list(args)
        if legacy_args:
            first = legacy_args.pop(0)
            if isinstance(first, list):  # legacy Proxy runtime order
                self.activate_proxies = first
                if legacy_args:
                    self.cutoff_date = legacy_args.pop(0)
                if legacy_args:
                    self.deploy_mode = legacy_args.pop(0)
            else:
                self.cutoff_date = first
                if legacy_args:
                    self.use_cache = legacy_args.pop(0)

        if isinstance(self.cutoff_date, str):
            try:
                self.cutoff_date = dt.datetime.fromisoformat(self.cutoff_date)
            except ValueError:
                self.cutoff_date = None

    @staticmethod
    def endpoint(category: str, endpoint: str, description: str, params: dict, response: list,
                 name: str = None, sub_category: str = None, remove_keys: list = None,
                 dt_cutoff: tuple = None, method: str = 'GET'):
        """Decorator that records metadata about an API endpoint."""
        def decorator(func):
            func.endpoint_info = {
                'category': category,
                'endpoint': endpoint,
                'name': name,
                'description': description,
                'sub_category': sub_category,
                'remove_keys': remove_keys,
                'params': params,
                'response': response,
                'dt_cutoff': dt_cutoff,
                'method': method
            }
            return func
        return decorator

    @staticmethod
    def postcall(func):
        func.is_postcall = True
        return func

    # ------------------------------------------------------------------
    # Endpoint metadata helpers
    # ------------------------------------------------------------------

    def _endpoint_methods(self):
        """
        Yield ``(attr_name, method, endpoint_info)`` triples for every method
        decorated with :func:`BaseProxy.endpoint`.
        """
        for name, method in inspect.getmembers(self, predicate=callable):
            info = getattr(method, "endpoint_info", None)
            if info:
                yield name, method, info

    def endpoint_directory(self) -> List[Dict[str, Any]]:
        """
        Return a structured list describing every endpoint exposed by this proxy.
        """
        directory: List[Dict[str, Any]] = []
        for name, method, info in self._endpoint_methods():
            entry = dict(info)
            entry.setdefault("name", info.get("name") or name)
            entry["callable"] = name
            entry["docstring"] = inspect.getdoc(method)
            directory.append(entry)
        directory.sort(key=lambda item: ((item.get("category") or ""), item.get("endpoint") or ""))
        return directory

    def api_directory(self) -> Dict[str, Any]:
        """
        Return proxy metadata plus the endpoint directory.
        """
        return {
            "id": getattr(self, "_proxy_path", self.__class__.__name__),
            "display_name": getattr(self, "_proxy_name", self.__class__.__name__),
            "description": getattr(self, "_proxy_description", ""),
            "endpoints": self.endpoint_directory(),
        }

    def auto_test(self) -> Dict[str, Dict[str, Any]]:
        """
        Perform light-weight validation of endpoint metadata.

        Returns a dict mapping callable name to ``{"status": "...", "issues": [...]}``.
        """
        results: Dict[str, Dict[str, Any]] = {}
        for entry in self.endpoint_directory():
            issues: List[str] = []
            params = entry.get("params")
            if not isinstance(params, dict):
                issues.append("params")
            if entry.get("response") is None:
                issues.append("response")
            status = "ok" if not issues else "warning"
            results[entry["callable"]] = {"status": status, "issues": issues}
        return results

__init__(*args, activate_proxies=None, cutoff_date=None, deploy_mode=False, use_cache=True, auto_discover=None, **kwargs)

Support both legacy signatures (cutoff_date, use_cache) and the newer keyword-driven one.

Source code in lllm/proxies/base.py 
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def __init__(
    self,
    *args,
    activate_proxies: Optional[List[str]] = None,
    cutoff_date: Optional[dt.datetime] = None,
    deploy_mode: bool = False,
    use_cache: bool = True,
    auto_discover: Optional[bool] = None,
    **kwargs,
):
    """
    Support both legacy signatures (cutoff_date, use_cache) and the newer keyword-driven one.
    """
    self.activate_proxies = activate_proxies[:] if activate_proxies else []
    self.cutoff_date = cutoff_date
    self.deploy_mode = deploy_mode
    self.use_cache = use_cache
    self.auto_discover = auto_discover

    legacy_args = list(args)
    if legacy_args:
        first = legacy_args.pop(0)
        if isinstance(first, list):  # legacy Proxy runtime order
            self.activate_proxies = first
            if legacy_args:
                self.cutoff_date = legacy_args.pop(0)
            if legacy_args:
                self.deploy_mode = legacy_args.pop(0)
        else:
            self.cutoff_date = first
            if legacy_args:
                self.use_cache = legacy_args.pop(0)

    if isinstance(self.cutoff_date, str):
        try:
            self.cutoff_date = dt.datetime.fromisoformat(self.cutoff_date)
        except ValueError:
            self.cutoff_date = None

api_directory()

Return proxy metadata plus the endpoint directory.

Source code in lllm/proxies/base.py 
103
104
105
106
107
108
109
110
111
112
def api_directory(self) -> Dict[str, Any]:
    """
    Return proxy metadata plus the endpoint directory.
    """
    return {
        "id": getattr(self, "_proxy_path", self.__class__.__name__),
        "display_name": getattr(self, "_proxy_name", self.__class__.__name__),
        "description": getattr(self, "_proxy_description", ""),
        "endpoints": self.endpoint_directory(),
    }

auto_test()

Perform light-weight validation of endpoint metadata.

Returns a dict mapping callable name to {"status": "...", "issues": [...]}.

Source code in lllm/proxies/base.py 
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def auto_test(self) -> Dict[str, Dict[str, Any]]:
    """
    Perform light-weight validation of endpoint metadata.

    Returns a dict mapping callable name to ``{"status": "...", "issues": [...]}``.
    """
    results: Dict[str, Dict[str, Any]] = {}
    for entry in self.endpoint_directory():
        issues: List[str] = []
        params = entry.get("params")
        if not isinstance(params, dict):
            issues.append("params")
        if entry.get("response") is None:
            issues.append("response")
        status = "ok" if not issues else "warning"
        results[entry["callable"]] = {"status": status, "issues": issues}
    return results

endpoint(category, endpoint, description, params, response, name=None, sub_category=None, remove_keys=None, dt_cutoff=None, method='GET') staticmethod

Decorator that records metadata about an API endpoint.

Source code in lllm/proxies/base.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
@staticmethod
def endpoint(category: str, endpoint: str, description: str, params: dict, response: list,
             name: str = None, sub_category: str = None, remove_keys: list = None,
             dt_cutoff: tuple = None, method: str = 'GET'):
    """Decorator that records metadata about an API endpoint."""
    def decorator(func):
        func.endpoint_info = {
            'category': category,
            'endpoint': endpoint,
            'name': name,
            'description': description,
            'sub_category': sub_category,
            'remove_keys': remove_keys,
            'params': params,
            'response': response,
            'dt_cutoff': dt_cutoff,
            'method': method
        }
        return func
    return decorator

endpoint_directory()

Return a structured list describing every endpoint exposed by this proxy.

Source code in lllm/proxies/base.py 
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
def endpoint_directory(self) -> List[Dict[str, Any]]:
    """
    Return a structured list describing every endpoint exposed by this proxy.
    """
    directory: List[Dict[str, Any]] = []
    for name, method, info in self._endpoint_methods():
        entry = dict(info)
        entry.setdefault("name", info.get("name") or name)
        entry["callable"] = name
        entry["docstring"] = inspect.getdoc(method)
        directory.append(entry)
    directory.sort(key=lambda item: ((item.get("category") or ""), item.get("endpoint") or ""))
    return directory

Proxy

lllm.proxies.base.Proxy

Runtime registry that instantiates every discovered proxy and forwards calls.

Agents rarely instantiate this directly; instead the sandbox or higher-level tooling wires it up so prompts can enumerate available endpoints for tool selection.

Source code in lllm/proxies/base.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
class Proxy:
    """
    Runtime registry that instantiates every discovered proxy and forwards calls.

    Agents rarely instantiate this directly; instead the sandbox or higher-level tooling
    wires it up so prompts can enumerate available endpoints for tool selection.
    """

    def __init__(
        self,
        activate_proxies: Optional[List[str]] = None,
        cutoff_date: dt.datetime = None,
        deploy_mode: bool = False,
        *,
        auto_discover: Optional[bool] = None,
    ):
        from lllm.core.discovery import auto_discover_if_enabled
        auto_discover_if_enabled(auto_discover)
        self.activate_proxies = activate_proxies or []
        self.cutoff_date = cutoff_date
        self.deploy_mode = deploy_mode
        self.proxies: Dict[str, BaseProxy] = {}
        self._auto_discover_flag = auto_discover
        self._load_registered_proxies()

    def _load_registered_proxies(self):
        for name, proxy_cls in PROXY_REGISTRY.items():
            if self.activate_proxies and name not in self.activate_proxies:
                continue
            try:
                instance = proxy_cls(
                    cutoff_date=self.cutoff_date,
                    activate_proxies=self.activate_proxies,
                    deploy_mode=self.deploy_mode,
                    auto_discover=self._auto_discover_flag,
                )
            except TypeError:
                # Fallback to legacy positional order if subclass has not been updated yet
                instance = proxy_cls(self.activate_proxies, self.cutoff_date, self.deploy_mode)
            self.proxies[name] = instance

    def register(self, name: str, proxy_cls: Any):
        """Register (or override) a proxy implementation at runtime."""
        if name in self.proxies:
            U.cprint(f'Proxy {name} already instantiated, overwriting instance', 'y')
        try:
            instance = proxy_cls(
                cutoff_date=self.cutoff_date,
                activate_proxies=self.activate_proxies,
                deploy_mode=self.deploy_mode,
                auto_discover=self._auto_discover_flag,
            )
        except TypeError:
            instance = proxy_cls(self.activate_proxies, self.cutoff_date, self.deploy_mode)
        self.proxies[name] = instance

    def available(self) -> List[str]:
        """Return the sorted list of proxy identifiers currently loaded."""
        return sorted(self.proxies.keys())

    def api_catalog(self) -> Dict[str, Dict[str, Any]]:
        """Return the API directory for every loaded proxy."""
        return {name: proxy.api_directory() for name, proxy in self.proxies.items()}

    def get_api_directory(self, proxy_name: str) -> Dict[str, Any]:
        """Convenience wrapper that returns the directory for a single proxy."""
        if proxy_name not in self.proxies:
            raise KeyError(f"Proxy '{proxy_name}' not registered")
        return self.proxies[proxy_name].api_directory()

    def retrieve_api_docs(self, proxy_name: Optional[str] = None) -> str:
        """
        Render a human-readable overview of the available endpoints.

        Args:
            proxy_name: Optional identifier. If omitted, all proxies are included.
        """
        if proxy_name is not None:
            target_names = [proxy_name]
        else:
            target_names = sorted(self.proxies.keys())

        sections: List[str] = []
        for name in target_names:
            if name not in self.proxies:
                raise KeyError(f"Proxy '{name}' not registered")
            meta = self.proxies[name].api_directory()
            header = f"## {meta['display_name']} ({name})"
            description = (meta.get("description") or "").strip()
            lines = [header]
            if description:
                lines.append(description)
            for endpoint in meta.get("endpoints", []):
                method = (endpoint.get("method") or "GET").upper()
                desc = endpoint.get("description") or ""
                line = f"- **{endpoint.get('endpoint')}** [{method}] – {desc}"
                lines.append(line.strip())
                params = endpoint.get("params") or {}
                if isinstance(params, dict) and params:
                    for param_name, spec in params.items():
                        if isinstance(spec, tuple) and spec:
                            type_hint = spec[0]
                            example = spec[1] if len(spec) > 1 else None
                        else:
                            type_hint = None
                            example = spec
                        type_name = getattr(type_hint, "__name__", str(type_hint)) if type_hint else "Any"
                        if isinstance(example, (list, dict)):
                            example_preview = str(example)[:60]
                        else:
                            example_preview = example
                        lines.append(f"    - `{param_name}` ({type_name}) e.g. {example_preview}")
            sections.append("\n".join(lines).strip())
        return "\n\n".join(sections).strip()

    def _resolve(self, endpoint: str) -> tuple[str, str]:
        if '.' in endpoint:
            parts = endpoint.split('.', 1)
            return parts[0], parts[1]
        path_parts = endpoint.split('/')
        if len(path_parts) < 2:
            raise ValueError(f"Invalid endpoint '{endpoint}'. Use '<proxy>.<method>' or '<proxy>/<method>'.")
        return '/'.join(path_parts[:-1]), path_parts[-1]

    def __call__(self, endpoint: str, *args, **kwargs):
        """Dispatch ``proxy_path.endpoint_name`` or ``proxy_path/endpoint`` to the proxy."""
        proxy_name, func_name = self._resolve(endpoint)
        if proxy_name not in self.proxies:
            raise KeyError(f"Proxy '{proxy_name}' not registered. Available: {list(self.proxies.keys())}")
        proxy = self.proxies[proxy_name]
        if not hasattr(proxy, func_name):
            raise AttributeError(f"Proxy '{proxy_name}' has no endpoint '{func_name}'")
        handler = getattr(proxy, func_name)
        return handler(*args, **kwargs)

__call__(endpoint, *args, **kwargs)

Dispatch proxy_path.endpoint_name or proxy_path/endpoint to the proxy.

Source code in lllm/proxies/base.py 
256
257
258
259
260
261
262
263
264
265
def __call__(self, endpoint: str, *args, **kwargs):
    """Dispatch ``proxy_path.endpoint_name`` or ``proxy_path/endpoint`` to the proxy."""
    proxy_name, func_name = self._resolve(endpoint)
    if proxy_name not in self.proxies:
        raise KeyError(f"Proxy '{proxy_name}' not registered. Available: {list(self.proxies.keys())}")
    proxy = self.proxies[proxy_name]
    if not hasattr(proxy, func_name):
        raise AttributeError(f"Proxy '{proxy_name}' has no endpoint '{func_name}'")
    handler = getattr(proxy, func_name)
    return handler(*args, **kwargs)

api_catalog()

Return the API directory for every loaded proxy.

Source code in lllm/proxies/base.py 
192
193
194
def api_catalog(self) -> Dict[str, Dict[str, Any]]:
    """Return the API directory for every loaded proxy."""
    return {name: proxy.api_directory() for name, proxy in self.proxies.items()}

available()

Return the sorted list of proxy identifiers currently loaded.

Source code in lllm/proxies/base.py 
188
189
190
def available(self) -> List[str]:
    """Return the sorted list of proxy identifiers currently loaded."""
    return sorted(self.proxies.keys())

get_api_directory(proxy_name)

Convenience wrapper that returns the directory for a single proxy.

Source code in lllm/proxies/base.py 
196
197
198
199
200
def get_api_directory(self, proxy_name: str) -> Dict[str, Any]:
    """Convenience wrapper that returns the directory for a single proxy."""
    if proxy_name not in self.proxies:
        raise KeyError(f"Proxy '{proxy_name}' not registered")
    return self.proxies[proxy_name].api_directory()

register(name, proxy_cls)

Register (or override) a proxy implementation at runtime.

Source code in lllm/proxies/base.py 
173
174
175
176
177
178
179
180
181
182
183
184
185
186
def register(self, name: str, proxy_cls: Any):
    """Register (or override) a proxy implementation at runtime."""
    if name in self.proxies:
        U.cprint(f'Proxy {name} already instantiated, overwriting instance', 'y')
    try:
        instance = proxy_cls(
            cutoff_date=self.cutoff_date,
            activate_proxies=self.activate_proxies,
            deploy_mode=self.deploy_mode,
            auto_discover=self._auto_discover_flag,
        )
    except TypeError:
        instance = proxy_cls(self.activate_proxies, self.cutoff_date, self.deploy_mode)
    self.proxies[name] = instance

retrieve_api_docs(proxy_name=None)

Render a human-readable overview of the available endpoints.

Parameters:

Name Type Description Default
proxy_name Optional[str]

Optional identifier. If omitted, all proxies are included.

 None
Source code in lllm/proxies/base.py 
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
def retrieve_api_docs(self, proxy_name: Optional[str] = None) -> str:
    """
    Render a human-readable overview of the available endpoints.

    Args:
        proxy_name: Optional identifier. If omitted, all proxies are included.
    """
    if proxy_name is not None:
        target_names = [proxy_name]
    else:
        target_names = sorted(self.proxies.keys())

    sections: List[str] = []
    for name in target_names:
        if name not in self.proxies:
            raise KeyError(f"Proxy '{name}' not registered")
        meta = self.proxies[name].api_directory()
        header = f"## {meta['display_name']} ({name})"
        description = (meta.get("description") or "").strip()
        lines = [header]
        if description:
            lines.append(description)
        for endpoint in meta.get("endpoints", []):
            method = (endpoint.get("method") or "GET").upper()
            desc = endpoint.get("description") or ""
            line = f"- **{endpoint.get('endpoint')}** [{method}] – {desc}"
            lines.append(line.strip())
            params = endpoint.get("params") or {}
            if isinstance(params, dict) and params:
                for param_name, spec in params.items():
                    if isinstance(spec, tuple) and spec:
                        type_hint = spec[0]
                        example = spec[1] if len(spec) > 1 else None
                    else:
                        type_hint = None
                        example = spec
                    type_name = getattr(type_hint, "__name__", str(type_hint)) if type_hint else "Any"
                    if isinstance(example, (list, dict)):
                        example_preview = str(example)[:60]
                    else:
                        example_preview = example
                    lines.append(f"    - `{param_name}` ({type_name}) e.g. {example_preview}")
        sections.append("\n".join(lines).strip())
    return "\n\n".join(sections).strip()

ProxyRegistrator

lllm.proxies.base.ProxyRegistrator(path, name, description)

Source code in lllm/proxies/base.py 
275
276
277
278
279
280
281
282
def ProxyRegistrator(path: str, name: str, description: str):
    def decorator(cls):
        cls._proxy_path = path
        cls._proxy_name = name
        cls._proxy_description = description
        register_proxy(path, cls, overwrite=True)
        return cls
    return decorator