vis-agent 0.5.22.dev9332__py3-none-any.whl → 0.5.22.dev9358__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,7 @@
1
1
  """Shared engine session API and explicit HTTP gateway transport.
2
2
 
3
- ExecutionLayer owns the route and session API without choosing a transport.
3
+ EngineClient owns the session API without choosing a transport. Its `routes`
4
+ object, from `_routes.py`, holds one method for each gateway route.
4
5
  GatewayClient adds authenticated HTTP, leases and bounded SSE. A timeout never
5
6
  means that a submitted mutation was rolled back.
6
7
  """
@@ -23,6 +24,7 @@ from abc import ABC, abstractmethod
23
24
  from collections.abc import Generator, Iterable, Mapping
24
25
  from concurrent.futures import ThreadPoolExecutor
25
26
  from dataclasses import dataclass, field
27
+ from functools import cached_property
26
28
  from pathlib import PurePosixPath
27
29
  from typing import (
28
30
  TYPE_CHECKING,
@@ -46,6 +48,7 @@ from blockether.vis.activity import ActivityProjection
46
48
  from blockether.vis.engine import _types
47
49
  from blockether.vis.engine._groups import SessionGroup
48
50
  from blockether.vis.engine._models import Model, SessionModel
51
+ from blockether.vis.engine._routes import Routes
49
52
  from blockether.vis.views import EVENT_DEFINITIONS, InputView, LiveView, ViewEvent
50
53
 
51
54
  if TYPE_CHECKING:
@@ -60,7 +63,6 @@ if TYPE_CHECKING:
60
63
  JSONValue: TypeAlias = (
61
64
  str | int | float | bool | None | list["JSONValue"] | dict[str, "JSONValue"]
62
65
  )
63
- Query: TypeAlias = Mapping[str, str | int | float | bool | None]
64
66
 
65
67
 
66
68
  class SessionOptions(TypedDict):
@@ -433,7 +435,7 @@ class Event:
433
435
  )
434
436
 
435
437
 
436
- class ExecutionLayer(ABC):
438
+ class EngineClient(ABC):
437
439
  """Shared session API for local processes and explicit gateway connections.
438
440
 
439
441
  Applications normally choose `blockether.vis.engine.StdioEngineClient`,
@@ -442,7 +444,7 @@ class ExecutionLayer(ABC):
442
444
  conversation or `session` to attach to an existing session ID. `Agent` wraps
443
445
  this API when you only need one conversation.
444
446
 
445
- The named HTTP methods below expose lower-level engine routes. Their `body`
447
+ `routes` gives one method for each lower-level gateway route. Their `body`
446
448
  and `query` values use the gateway's wire schema, not any Python object. For
447
449
  ordinary workflows, use `Session` and `Turn` methods. Route failures raise
448
450
  `GatewayError`. IO failures and malformed replies raise `TransportError` or
@@ -452,13 +454,13 @@ class ExecutionLayer(ABC):
452
454
  timeout: Positive finite transport timeout in seconds. Defaults to 30.
453
455
  This is independent of a turn's wait deadline.
454
456
 
455
- Use each layer and its session handles on one calling thread. Two exceptions
457
+ Use each client and its session handles on one calling thread. Two exceptions
456
458
  apply to event streams: `close` is safe from any thread, and `async for`
457
459
  reads a stream on one worker thread that the stream owns. Context entry
458
460
  calls `connect`, and context exit calls `close`. A custom transport
459
461
  implements `connect`, `close`, `session_options` and `_open`. `_open`
460
462
  returns a context-managed binary response with status and headers. Path and
461
- channel defaults belong to the layer, not to `Agent`.
463
+ channel defaults belong to the client, not to `Agent`.
462
464
  """
463
465
 
464
466
  def __init__(self, *, timeout: float = 30):
@@ -469,12 +471,12 @@ class ExecutionLayer(ABC):
469
471
  self._client_extensions = {}
470
472
 
471
473
  @abstractmethod
472
- def connect(self) -> ExecutionLayer:
473
- """Connect or start the layer. Repeated calls keep the same connection."""
474
+ def connect(self) -> EngineClient:
475
+ """Connect or start the client. Repeated calls keep the same connection."""
474
476
 
475
477
  @abstractmethod
476
478
  def close(self) -> None:
477
- """Release this layer's resources without deleting remote sessions."""
479
+ """Release this client's resources without deleting remote sessions."""
478
480
 
479
481
  @abstractmethod
480
482
  def session_options(self, project=".") -> SessionOptions:
@@ -540,6 +542,8 @@ class ExecutionLayer(ABC):
540
542
  operation = entry["operations"][method.lower()]
541
543
  if operation["response"] == "sse":
542
544
  raise ValueError("SSE requires a streaming API")
545
+ if operation["response"] == "websocket":
546
+ raise ValueError("WebSocket media is not supported by this SDK")
543
547
  request_kind = operation["request"]
544
548
  if body is not None and request_kind != "json":
545
549
  raise ValueError("this operation does not accept a JSON body")
@@ -610,12 +614,17 @@ class ExecutionLayer(ABC):
610
614
 
611
615
  return Sounds(self)
612
616
 
617
+ @cached_property
618
+ def routes(self) -> Routes:
619
+ """Return the `Routes` API: one method for each gateway route."""
620
+ return Routes(self)
621
+
613
622
  def session(self, sid: str) -> Session:
614
623
  """Return a lightweight handle for an existing session ID.
615
624
 
616
625
  This does not fetch or validate the remote session. Use `Session.read`
617
626
  to get its state. That request reports a missing session. The handle
618
- borrows this layer and does not own its lifetime.
627
+ borrows this client and does not own its lifetime.
619
628
  """
620
629
  return Session(self, sid)
621
630
 
@@ -649,7 +658,7 @@ class ExecutionLayer(ABC):
649
658
  The list is empty while the person turns global apps off. This is a
650
659
  snapshot; the owner gets the events of its app from `attach_app`.
651
660
  """
652
- answer = self.get_apps(query={"archived": "true"} if archived else None)
661
+ answer = self.routes.get_apps(query={"archived": "true"} if archived else None)
653
662
  try:
654
663
  return [LiveView.from_wire(item) for item in _field(answer, "views", list)]
655
664
  except ValueError:
@@ -657,7 +666,7 @@ class ExecutionLayer(ABC):
657
666
 
658
667
  def app(self, view_id: str) -> LiveView:
659
668
  """Read one global app by id, also a closed or restored app."""
660
- data = _field(self.get_app(view_id), "view", dict)
669
+ data = _field(self.routes.get_app(view_id), "view", dict)
661
670
  try:
662
671
  return LiveView.from_wire(data)
663
672
  except ValueError:
@@ -667,7 +676,7 @@ class ExecutionLayer(ABC):
667
676
  """Send an operator action to a global app, as `Session.view_action` does."""
668
677
  body = {**values, "action": action}
669
678
  validate("view", "operator_action", body)
670
- return self.post_app_actions(view_id, body=body)
679
+ return self.routes.post_app_actions(view_id, body=body)
671
680
 
672
681
  def web_brand(self) -> _types.WebBrand:
673
682
  """Read the white label of the web app that this gateway serves.
@@ -675,7 +684,7 @@ class ExecutionLayer(ABC):
675
684
  The answer has only the keys that are set: `name`, `logo`, `href`,
676
685
  `links` and `theme`. An empty answer means the Vis default.
677
686
  """
678
- brand = self.get_web_brand()
687
+ brand = self.routes.get_web_brand()
679
688
  if not isinstance(brand, dict):
680
689
  raise ProtocolError("invalid web brand response")
681
690
  return brand
@@ -715,14 +724,14 @@ class ExecutionLayer(ABC):
715
724
  if theme is not None:
716
725
  body["theme"] = {**theme}
717
726
  validate("gateway", "web_brand", body)
718
- brand = self.put_web_brand(body=body)
727
+ brand = self.routes.put_web_brand(body=body)
719
728
  if not isinstance(brand, dict):
720
729
  raise ProtocolError("invalid web brand response")
721
730
  return brand
722
731
 
723
732
  def clear_web_brand(self) -> None:
724
733
  """Remove the white label: the web app shows the Vis default again."""
725
- self.delete_web_brand()
734
+ self.routes.delete_web_brand()
726
735
 
727
736
  def create_session(
728
737
  self,
@@ -744,7 +753,7 @@ class ExecutionLayer(ABC):
744
753
  the folder that the session works in.
745
754
  timeout: Optional timeout in seconds for this creation request.
746
755
  **options: Session creation fields from the gateway contract. For a
747
- project path, pass `**layer.session_options(project)`. This
756
+ project path, pass `**client.session_options(project)`. This
748
757
  applies local and gateway path rules and channel defaults
749
758
  correctly.
750
759
 
@@ -783,7 +792,7 @@ class ExecutionLayer(ABC):
783
792
  without a project has no groups.
784
793
  """
785
794
  query = {**_project_scope(root, project_id, "project"), "archived": archived}
786
- rows = _field(self.get_session_groups(query=query), "groups", list)
795
+ rows = _field(self.routes.get_session_groups(query=query), "groups", list)
787
796
  return [_group(row) for row in rows]
788
797
 
789
798
  def create_group(
@@ -804,7 +813,7 @@ class ExecutionLayer(ABC):
804
813
  body = {"name": name, **_project_scope(root, project_id, "project_id")}
805
814
  if color is not None:
806
815
  body["color"] = color
807
- return _group(self.post_session_groups(body=body))
816
+ return _group(self.routes.post_session_groups(body=body))
808
817
 
809
818
  def group(
810
819
  self,
@@ -858,7 +867,7 @@ class ExecutionLayer(ABC):
858
867
  }
859
868
  if not body:
860
869
  raise ValueError("give name, color or archived")
861
- return _group(self.patch_session_group(_group_id(group), body=body))
870
+ return _group(self.routes.patch_session_group(_group_id(group), body=body))
862
871
 
863
872
  def delete_group(
864
873
  self, group: SessionGroup | str, *, delete_sessions: bool = False
@@ -869,7 +878,9 @@ class ExecutionLayer(ABC):
869
878
  The answer has `scattered_session_ids` and `deleted_session_ids`.
870
879
  """
871
880
  mode = "delete" if delete_sessions else "detach"
872
- return self.delete_session_group(_group_id(group), query={"sessions": mode})
881
+ return self.routes.delete_session_group(
882
+ _group_id(group), query={"sessions": mode}
883
+ )
873
884
 
874
885
  def agent_name(self) -> str:
875
886
  """Return the name that the gateway gives to the agent.
@@ -878,7 +889,9 @@ class ExecutionLayer(ABC):
878
889
  variable `VIS_AGENT_NAME` of the gateway and a locked name are the name
879
890
  of the agent in each project.
880
891
  """
881
- return _agent_name(self.get_setting("agent_name", query={"scope": "global"}))
892
+ return _agent_name(
893
+ self.routes.get_setting("agent_name", query={"scope": "global"})
894
+ )
882
895
 
883
896
  def set_agent_name(self, name: str, *, locked: bool | None = None) -> str:
884
897
  """Save the agent name of the gateway and return the name in effect.
@@ -902,7 +915,7 @@ class ExecutionLayer(ABC):
902
915
  }
903
916
  if locked is not None:
904
917
  body["is_locked"] = locked
905
- return _agent_name(self.post_settings(body=body))
918
+ return _agent_name(self.routes.post_settings(body=body))
906
919
 
907
920
  def machine_name(self) -> str | None:
908
921
  """Return the name of the gateway machine, or None when it has no name.
@@ -912,7 +925,7 @@ class ExecutionLayer(ABC):
912
925
  saved name.
913
926
  """
914
927
  return _machine_name(
915
- self.get_setting("machine_name", query={"scope": "global"})
928
+ self.routes.get_setting("machine_name", query={"scope": "global"})
916
929
  )
917
930
 
918
931
  def set_machine_name(self, name: str | None) -> str | None:
@@ -930,7 +943,7 @@ class ExecutionLayer(ABC):
930
943
  body["action"] = "inherit"
931
944
  else:
932
945
  body.update(action="value", value=name.strip())
933
- return _machine_name(self.post_settings(body=body))
946
+ return _machine_name(self.routes.post_settings(body=body))
934
947
 
935
948
  def restore_session(
936
949
  self,
@@ -962,7 +975,9 @@ class ExecutionLayer(ABC):
962
975
  for name, value in (("root", root), ("group_id", group_id), ("key", key))
963
976
  if value is not None
964
977
  }
965
- reply = self.post_sessions_import(query=query, timeout=timeout, content=data)
978
+ reply = self.routes.post_sessions_import(
979
+ query=query, timeout=timeout, content=data
980
+ )
966
981
  return self.session(_field(reply, "id", str))
967
982
 
968
983
  @staticmethod
@@ -1000,64 +1015,6 @@ class ExecutionLayer(ABC):
1000
1015
  extensions.clear()
1001
1016
  self._client_extensions.clear()
1002
1017
 
1003
- def put_session_client_extensions(
1004
- self, sid: str, *, body: JSONValue, timeout: float | None = None
1005
- ) -> _types.EmptyObject:
1006
- """PUT /v1/sessions/:sid/client-extensions — bind client-owned declarations."""
1007
- return self._request(
1008
- "PUT",
1009
- "/v1/sessions/:sid/client-extensions",
1010
- path={"sid": sid},
1011
- body=body,
1012
- timeout=timeout,
1013
- ).json()
1014
-
1015
- def delete_session_client_extensions(
1016
- self, sid: str, *, timeout: float | None = None
1017
- ) -> _types.EmptyObject:
1018
- """DELETE /v1/sessions/:sid/client-extensions — detach owned callbacks."""
1019
- return self._request(
1020
- "DELETE",
1021
- "/v1/sessions/:sid/client-extensions",
1022
- path={"sid": sid},
1023
- timeout=timeout,
1024
- ).json()
1025
-
1026
- def get_session_client_calls(
1027
- self, sid: str, *, timeout: float | None = None
1028
- ) -> _types.ClientCalls:
1029
- """GET /v1/sessions/:sid/client-calls — retrieve pending owned calls."""
1030
- return self._request(
1031
- "GET",
1032
- "/v1/sessions/:sid/client-calls",
1033
- path={"sid": sid},
1034
- timeout=timeout,
1035
- ).json()
1036
-
1037
- def post_session_client_call_result(
1038
- self, sid: str, call_id: str, *, body: JSONValue, timeout: float | None = None
1039
- ) -> _types.EmptyObject:
1040
- """POST /v1/sessions/:sid/client-calls/:call_id/result — acknowledge one call."""
1041
- return self._request(
1042
- "POST",
1043
- "/v1/sessions/:sid/client-calls/:call_id/result",
1044
- path={"sid": sid, "call_id": call_id},
1045
- body=body,
1046
- timeout=timeout,
1047
- ).json()
1048
-
1049
- def post_session_client_call_activity(
1050
- self, sid: str, call_id: str, *, body: JSONValue, timeout: float | None = None
1051
- ) -> _types.EmptyObject:
1052
- """POST /v1/sessions/:sid/client-calls/:call_id/activity — publish presentation."""
1053
- return self._request(
1054
- "POST",
1055
- "/v1/sessions/:sid/client-calls/:call_id/activity",
1056
- path={"sid": sid, "call_id": call_id},
1057
- body=body,
1058
- timeout=timeout,
1059
- ).json()
1060
-
1061
1018
  def list_sessions(self, **query) -> _types.SessionList:
1062
1019
  """Return one page with next_cursor. It does not fetch every session.
1063
1020
 
@@ -1067,293 +1024,6 @@ class ExecutionLayer(ABC):
1067
1024
  """
1068
1025
  return self._request("GET", "/v1/sessions", query=query).json()
1069
1026
 
1070
- def get_capabilities(
1071
- self, *, query: Query | None = None, timeout: float | None = None
1072
- ) -> _types.Capabilities:
1073
- """GET /v1/capabilities — json response."""
1074
- response = self._request(
1075
- "GET", "/v1/capabilities", path={}, query=query, timeout=timeout
1076
- )
1077
- return response.json()
1078
-
1079
- def get_devices(
1080
- self, *, query: Query | None = None, timeout: float | None = None
1081
- ) -> _types.Devices:
1082
- """GET /v1/devices — json response."""
1083
- response = self._request(
1084
- "GET", "/v1/devices", path={}, query=query, timeout=timeout
1085
- )
1086
- return response.json()
1087
-
1088
- def post_devices(
1089
- self,
1090
- *,
1091
- query: Query | None = None,
1092
- timeout: float | None = None,
1093
- body: JSONValue = None,
1094
- ) -> _types.DeviceRegistered:
1095
- """POST /v1/devices — json response."""
1096
- response = self._request(
1097
- "POST", "/v1/devices", path={}, query=query, timeout=timeout, body=body
1098
- )
1099
- return response.json()
1100
-
1101
- def delete_device(
1102
- self, token: str, *, query: Query | None = None, timeout: float | None = None
1103
- ) -> _types.Removed:
1104
- """DELETE /v1/devices/:token — json response."""
1105
- response = self._request(
1106
- "DELETE",
1107
- "/v1/devices/:token",
1108
- path={"token": token},
1109
- query=query,
1110
- timeout=timeout,
1111
- )
1112
- return response.json()
1113
-
1114
- def post_devices_test(
1115
- self, *, query: Query | None = None, timeout: float | None = None
1116
- ) -> _types.DeviceTest:
1117
- """POST /v1/devices/actions/test — json response."""
1118
- response = self._request(
1119
- "POST", "/v1/devices/actions/test", path={}, query=query, timeout=timeout
1120
- )
1121
- return response.json()
1122
-
1123
- def get_fs(
1124
- self, *, query: Query | None = None, timeout: float | None = None
1125
- ) -> _types.FsListing:
1126
- """GET /v1/fs — json response."""
1127
- response = self._request("GET", "/v1/fs", path={}, query=query, timeout=timeout)
1128
- return response.json()
1129
-
1130
- def post_fs_mkdir(
1131
- self,
1132
- *,
1133
- query: Query | None = None,
1134
- timeout: float | None = None,
1135
- body: JSONValue = None,
1136
- ) -> _types.FsEntry:
1137
- """POST /v1/fs/actions/mkdir — json response."""
1138
- response = self._request(
1139
- "POST",
1140
- "/v1/fs/actions/mkdir",
1141
- path={},
1142
- query=query,
1143
- timeout=timeout,
1144
- body=body,
1145
- )
1146
- return response.json()
1147
-
1148
- def get_mcp_servers(
1149
- self, *, query: Query | None = None, timeout: float | None = None
1150
- ) -> _types.McpServers:
1151
- """GET /v1/mcp/servers — json response."""
1152
- response = self._request(
1153
- "GET", "/v1/mcp/servers", path={}, query=query, timeout=timeout
1154
- )
1155
- return response.json()
1156
-
1157
- def post_mcp_servers(
1158
- self,
1159
- *,
1160
- query: Query | None = None,
1161
- timeout: float | None = None,
1162
- body: JSONValue = None,
1163
- ) -> _types.McpServer:
1164
- """POST /v1/mcp/servers — json response."""
1165
- response = self._request(
1166
- "POST", "/v1/mcp/servers", path={}, query=query, timeout=timeout, body=body
1167
- )
1168
- return response.json()
1169
-
1170
- def delete_mcp_server(
1171
- self, name: str, *, query: Query | None = None, timeout: float | None = None
1172
- ) -> _types.McpDeleted:
1173
- """DELETE /v1/mcp/servers/:name — json response."""
1174
- response = self._request(
1175
- "DELETE",
1176
- "/v1/mcp/servers/:name",
1177
- path={"name": name},
1178
- query=query,
1179
- timeout=timeout,
1180
- )
1181
- return response.json()
1182
-
1183
- def put_mcp_server(
1184
- self,
1185
- name: str,
1186
- *,
1187
- query: Query | None = None,
1188
- timeout: float | None = None,
1189
- body: JSONValue = None,
1190
- ) -> _types.McpServer:
1191
- """PUT /v1/mcp/servers/:name — json response."""
1192
- response = self._request(
1193
- "PUT",
1194
- "/v1/mcp/servers/:name",
1195
- path={"name": name},
1196
- query=query,
1197
- timeout=timeout,
1198
- body=body,
1199
- )
1200
- return response.json()
1201
-
1202
- def post_mcp_server_enable(
1203
- self,
1204
- name: str,
1205
- *,
1206
- query: Query | None = None,
1207
- timeout: float | None = None,
1208
- body: JSONValue = None,
1209
- ) -> _types.McpServer:
1210
- """POST /v1/mcp/servers/:name/actions/enable — json response."""
1211
- response = self._request(
1212
- "POST",
1213
- "/v1/mcp/servers/:name/actions/enable",
1214
- path={"name": name},
1215
- query=query,
1216
- timeout=timeout,
1217
- body=body,
1218
- )
1219
- return response.json()
1220
-
1221
- def post_mcp_server_kill(
1222
- self, name: str, *, query: Query | None = None, timeout: float | None = None
1223
- ) -> _types.McpServer:
1224
- """POST /v1/mcp/servers/:name/actions/kill — json response."""
1225
- response = self._request(
1226
- "POST",
1227
- "/v1/mcp/servers/:name/actions/kill",
1228
- path={"name": name},
1229
- query=query,
1230
- timeout=timeout,
1231
- )
1232
- return response.json()
1233
-
1234
- def post_mcp_server_start(
1235
- self, name: str, *, query: Query | None = None, timeout: float | None = None
1236
- ) -> _types.McpServer:
1237
- """POST /v1/mcp/servers/:name/actions/start — json response."""
1238
- response = self._request(
1239
- "POST",
1240
- "/v1/mcp/servers/:name/actions/start",
1241
- path={"name": name},
1242
- query=query,
1243
- timeout=timeout,
1244
- )
1245
- return response.json()
1246
-
1247
- def post_mcp_server_auth_cancel(
1248
- self,
1249
- name: str,
1250
- *,
1251
- query: Query | None = None,
1252
- timeout: float | None = None,
1253
- body: JSONValue = None,
1254
- ) -> _types.McpAuthCancelled:
1255
- """POST /v1/mcp/servers/:name/auth/cancel — json response."""
1256
- response = self._request(
1257
- "POST",
1258
- "/v1/mcp/servers/:name/auth/cancel",
1259
- path={"name": name},
1260
- query=query,
1261
- timeout=timeout,
1262
- body=body,
1263
- )
1264
- return response.json()
1265
-
1266
- def post_mcp_server_auth_complete(
1267
- self,
1268
- name: str,
1269
- *,
1270
- query: Query | None = None,
1271
- timeout: float | None = None,
1272
- body: JSONValue = None,
1273
- ) -> _types.McpAuthFlow:
1274
- """POST /v1/mcp/servers/:name/auth/complete — json response."""
1275
- response = self._request(
1276
- "POST",
1277
- "/v1/mcp/servers/:name/auth/complete",
1278
- path={"name": name},
1279
- query=query,
1280
- timeout=timeout,
1281
- body=body,
1282
- )
1283
- return response.json()
1284
-
1285
- def post_mcp_server_auth_logout(
1286
- self, name: str, *, query: Query | None = None, timeout: float | None = None
1287
- ) -> _types.McpTokenStatus:
1288
- """POST /v1/mcp/servers/:name/auth/logout — json response."""
1289
- response = self._request(
1290
- "POST",
1291
- "/v1/mcp/servers/:name/auth/logout",
1292
- path={"name": name},
1293
- query=query,
1294
- timeout=timeout,
1295
- )
1296
- return response.json()
1297
-
1298
- def post_mcp_server_auth_poll(
1299
- self,
1300
- name: str,
1301
- *,
1302
- query: Query | None = None,
1303
- timeout: float | None = None,
1304
- body: JSONValue = None,
1305
- ) -> _types.McpAuthFlow:
1306
- """POST /v1/mcp/servers/:name/auth/poll — json response."""
1307
- response = self._request(
1308
- "POST",
1309
- "/v1/mcp/servers/:name/auth/poll",
1310
- path={"name": name},
1311
- query=query,
1312
- timeout=timeout,
1313
- body=body,
1314
- )
1315
- return response.json()
1316
-
1317
- def post_mcp_server_auth_start(
1318
- self, name: str, *, query: Query | None = None, timeout: float | None = None
1319
- ) -> _types.McpAuthFlow:
1320
- """POST /v1/mcp/servers/:name/auth/start — json response."""
1321
- response = self._request(
1322
- "POST",
1323
- "/v1/mcp/servers/:name/auth/start",
1324
- path={"name": name},
1325
- query=query,
1326
- timeout=timeout,
1327
- )
1328
- return response.json()
1329
-
1330
- def post_mcp_servers_test(
1331
- self,
1332
- *,
1333
- query: Query | None = None,
1334
- timeout: float | None = None,
1335
- body: JSONValue = None,
1336
- ) -> _types.McpTest:
1337
- """POST /v1/mcp/servers/actions/test — json response."""
1338
- response = self._request(
1339
- "POST",
1340
- "/v1/mcp/servers/actions/test",
1341
- path={},
1342
- query=query,
1343
- timeout=timeout,
1344
- body=body,
1345
- )
1346
- return response.json()
1347
-
1348
- def get_models(
1349
- self, *, query: Query | None = None, timeout: float | None = None
1350
- ) -> _types.ModelsCatalog:
1351
- """GET /v1/models — json response."""
1352
- response = self._request(
1353
- "GET", "/v1/models", path={}, query=query, timeout=timeout
1354
- )
1355
- return response.json()
1356
-
1357
1027
  def models(
1358
1028
  self,
1359
1029
  *,
@@ -1373,7 +1043,7 @@ class ExecutionLayer(ABC):
1373
1043
  report of its provider. The gateway reads provider limits in parallel
1374
1044
  and bounds each read, so a slow provider gives an error report.
1375
1045
  """
1376
- data = self.get_models(timeout=timeout)
1046
+ data = self.routes.get_models(timeout=timeout)
1377
1047
  return tuple(
1378
1048
  model
1379
1049
  for model in Model.many(_field(data, "models", list))
@@ -1390,2198 +1060,13 @@ class ExecutionLayer(ABC):
1390
1060
  report follows the provider limits schema. A failed read gives an
1391
1061
  error report, not an exception.
1392
1062
  """
1393
- answer = self.get_provider_limits(provider, timeout=timeout)
1063
+ answer = self.routes.get_provider_limits(provider, timeout=timeout)
1394
1064
  report = answer.get("report") if isinstance(answer, dict) else None
1395
1065
  if not isinstance(report, dict):
1396
1066
  raise ProtocolError("provider limits must be an object")
1397
1067
  validate("provider", "report", report)
1398
1068
  return report
1399
1069
 
1400
- def get_projects(
1401
- self, *, query: Query | None = None, timeout: float | None = None
1402
- ) -> _types.ProjectList:
1403
- """GET /v1/projects — json response."""
1404
- response = self._request(
1405
- "GET", "/v1/projects", path={}, query=query, timeout=timeout
1406
- )
1407
- return response.json()
1408
-
1409
- def post_projects(
1410
- self,
1411
- *,
1412
- query: Query | None = None,
1413
- timeout: float | None = None,
1414
- body: JSONValue = None,
1415
- ) -> _types.Project:
1416
- """POST /v1/projects — json response."""
1417
- response = self._request(
1418
- "POST", "/v1/projects", path={}, query=query, timeout=timeout, body=body
1419
- )
1420
- return response.json()
1421
-
1422
- def delete_project(
1423
- self, pid: str, *, query: Query | None = None, timeout: float | None = None
1424
- ) -> None:
1425
- """DELETE /v1/projects/:pid — empty response."""
1426
- self._request(
1427
- "DELETE",
1428
- "/v1/projects/:pid",
1429
- path={"pid": pid},
1430
- query=query,
1431
- timeout=timeout,
1432
- )
1433
- return None
1434
-
1435
- def get_project(
1436
- self, pid: str, *, query: Query | None = None, timeout: float | None = None
1437
- ) -> _types.Project:
1438
- """GET /v1/projects/:pid — json response."""
1439
- response = self._request(
1440
- "GET", "/v1/projects/:pid", path={"pid": pid}, query=query, timeout=timeout
1441
- )
1442
- return response.json()
1443
-
1444
- def patch_project(
1445
- self,
1446
- pid: str,
1447
- *,
1448
- query: Query | None = None,
1449
- timeout: float | None = None,
1450
- body: JSONValue = None,
1451
- ) -> _types.Project:
1452
- """PATCH /v1/projects/:pid — json response."""
1453
- response = self._request(
1454
- "PATCH",
1455
- "/v1/projects/:pid",
1456
- path={"pid": pid},
1457
- query=query,
1458
- timeout=timeout,
1459
- body=body,
1460
- )
1461
- return response.json()
1462
-
1463
- def patch_project_sessions(
1464
- self,
1465
- pid: str,
1466
- *,
1467
- query: Query | None = None,
1468
- timeout: float | None = None,
1469
- body: JSONValue = None,
1470
- ) -> _types.ProjectSessionsMoved:
1471
- """PATCH /v1/projects/:pid/sessions — json response."""
1472
- response = self._request(
1473
- "PATCH",
1474
- "/v1/projects/:pid/sessions",
1475
- path={"pid": pid},
1476
- query=query,
1477
- timeout=timeout,
1478
- body=body,
1479
- )
1480
- return response.json()
1481
-
1482
- def post_projects_ensure(
1483
- self,
1484
- *,
1485
- query: Query | None = None,
1486
- timeout: float | None = None,
1487
- body: JSONValue = None,
1488
- ) -> _types.Project:
1489
- """POST /v1/projects/actions/ensure — json response."""
1490
- response = self._request(
1491
- "POST",
1492
- "/v1/projects/actions/ensure",
1493
- path={},
1494
- query=query,
1495
- timeout=timeout,
1496
- body=body,
1497
- )
1498
- return response.json()
1499
-
1500
- def get_projects_overview(
1501
- self, *, query: Query | None = None, timeout: float | None = None
1502
- ) -> _types.ProjectOverview:
1503
- """GET /v1/projects/overview — json response."""
1504
- response = self._request(
1505
- "GET", "/v1/projects/overview", path={}, query=query, timeout=timeout
1506
- )
1507
- return response.json()
1508
-
1509
- def get_provider_presets(
1510
- self, *, query: Query | None = None, timeout: float | None = None
1511
- ) -> _types.ProviderPresets:
1512
- """GET /v1/provider-presets — json response."""
1513
- response = self._request(
1514
- "GET", "/v1/provider-presets", path={}, query=query, timeout=timeout
1515
- )
1516
- return response.json()
1517
-
1518
- def post_providers(
1519
- self,
1520
- *,
1521
- query: Query | None = None,
1522
- timeout: float | None = None,
1523
- body: JSONValue = None,
1524
- ) -> _types.RouterFleet:
1525
- """POST /v1/providers — json response."""
1526
- response = self._request(
1527
- "POST", "/v1/providers", path={}, query=query, timeout=timeout, body=body
1528
- )
1529
- return response.json()
1530
-
1531
- def delete_provider(
1532
- self,
1533
- provider_id: str,
1534
- *,
1535
- query: Query | None = None,
1536
- timeout: float | None = None,
1537
- ) -> _types.RouterFleet:
1538
- """DELETE /v1/providers/:provider-id — json response."""
1539
- response = self._request(
1540
- "DELETE",
1541
- "/v1/providers/:provider-id",
1542
- path={"provider-id": provider_id},
1543
- query=query,
1544
- timeout=timeout,
1545
- )
1546
- return response.json()
1547
-
1548
- def post_provider_auth_cancel(
1549
- self,
1550
- provider_id: str,
1551
- *,
1552
- query: Query | None = None,
1553
- timeout: float | None = None,
1554
- body: JSONValue = None,
1555
- ) -> _types.ProviderAuth:
1556
- """POST /v1/providers/:provider-id/auth/cancel — json response."""
1557
- response = self._request(
1558
- "POST",
1559
- "/v1/providers/:provider-id/auth/cancel",
1560
- path={"provider-id": provider_id},
1561
- query=query,
1562
- timeout=timeout,
1563
- body=body,
1564
- )
1565
- return response.json()
1566
-
1567
- def post_provider_auth_complete(
1568
- self,
1569
- provider_id: str,
1570
- *,
1571
- query: Query | None = None,
1572
- timeout: float | None = None,
1573
- body: JSONValue = None,
1574
- ) -> _types.ProviderAuth:
1575
- """POST /v1/providers/:provider-id/auth/complete — json response."""
1576
- response = self._request(
1577
- "POST",
1578
- "/v1/providers/:provider-id/auth/complete",
1579
- path={"provider-id": provider_id},
1580
- query=query,
1581
- timeout=timeout,
1582
- body=body,
1583
- )
1584
- return response.json()
1585
-
1586
- def post_provider_auth_poll(
1587
- self,
1588
- provider_id: str,
1589
- *,
1590
- query: Query | None = None,
1591
- timeout: float | None = None,
1592
- body: JSONValue = None,
1593
- ) -> _types.ProviderAuth:
1594
- """POST /v1/providers/:provider-id/auth/poll — json response."""
1595
- response = self._request(
1596
- "POST",
1597
- "/v1/providers/:provider-id/auth/poll",
1598
- path={"provider-id": provider_id},
1599
- query=query,
1600
- timeout=timeout,
1601
- body=body,
1602
- )
1603
- return response.json()
1604
-
1605
- def post_provider_auth_start(
1606
- self,
1607
- provider_id: str,
1608
- *,
1609
- query: Query | None = None,
1610
- timeout: float | None = None,
1611
- ) -> _types.ProviderAuth:
1612
- """POST /v1/providers/:provider-id/auth/start — json response."""
1613
- response = self._request(
1614
- "POST",
1615
- "/v1/providers/:provider-id/auth/start",
1616
- path={"provider-id": provider_id},
1617
- query=query,
1618
- timeout=timeout,
1619
- )
1620
- return response.json()
1621
-
1622
- def get_provider_limits(
1623
- self,
1624
- provider_id: str,
1625
- *,
1626
- query: Query | None = None,
1627
- timeout: float | None = None,
1628
- ) -> _types.ProviderLimits:
1629
- """GET /v1/providers/:provider-id/limits — json response."""
1630
- response = self._request(
1631
- "GET",
1632
- "/v1/providers/:provider-id/limits",
1633
- path={"provider-id": provider_id},
1634
- query=query,
1635
- timeout=timeout,
1636
- )
1637
- return response.json()
1638
-
1639
- def post_provider_reset_credits_consume(
1640
- self,
1641
- provider_id: str,
1642
- *,
1643
- query: Query | None = None,
1644
- timeout: float | None = None,
1645
- body: JSONValue = None,
1646
- ) -> _types.ProviderResetOutcome:
1647
- """POST /v1/providers/:provider-id/reset-credits/consume — json response."""
1648
- response = self._request(
1649
- "POST",
1650
- "/v1/providers/:provider-id/reset-credits/consume",
1651
- path={"provider-id": provider_id},
1652
- query=query,
1653
- timeout=timeout,
1654
- body=body,
1655
- )
1656
- return response.json()
1657
-
1658
- def post_provider_logout(
1659
- self,
1660
- provider_id: str,
1661
- *,
1662
- query: Query | None = None,
1663
- timeout: float | None = None,
1664
- ) -> _types.ProviderAuth:
1665
- """POST /v1/providers/:provider-id/logout — json response."""
1666
- response = self._request(
1667
- "POST",
1668
- "/v1/providers/:provider-id/logout",
1669
- path={"provider-id": provider_id},
1670
- query=query,
1671
- timeout=timeout,
1672
- )
1673
- return response.json()
1674
-
1675
- def get_provider_models(
1676
- self,
1677
- provider_id: str,
1678
- *,
1679
- query: Query | None = None,
1680
- timeout: float | None = None,
1681
- ) -> _types.ProviderModels:
1682
- """GET /v1/providers/:provider-id/models — json response."""
1683
- response = self._request(
1684
- "GET",
1685
- "/v1/providers/:provider-id/models",
1686
- path={"provider-id": provider_id},
1687
- query=query,
1688
- timeout=timeout,
1689
- )
1690
- return response.json()
1691
-
1692
- def get_provider_status(
1693
- self,
1694
- provider_id: str,
1695
- *,
1696
- query: Query | None = None,
1697
- timeout: float | None = None,
1698
- ) -> _types.ProviderStatus:
1699
- """GET /v1/providers/:provider-id/status — json response."""
1700
- response = self._request(
1701
- "GET",
1702
- "/v1/providers/:provider-id/status",
1703
- path={"provider-id": provider_id},
1704
- query=query,
1705
- timeout=timeout,
1706
- )
1707
- return response.json()
1708
-
1709
- def get_router(
1710
- self, *, query: Query | None = None, timeout: float | None = None
1711
- ) -> _types.RouterFleet:
1712
- """GET /v1/router — json response."""
1713
- response = self._request(
1714
- "GET", "/v1/router", path={}, query=query, timeout=timeout
1715
- )
1716
- return response.json()
1717
-
1718
- def patch_router(
1719
- self,
1720
- *,
1721
- query: Query | None = None,
1722
- timeout: float | None = None,
1723
- body: JSONValue = None,
1724
- ) -> _types.RouterFleet:
1725
- """PATCH /v1/router — json response."""
1726
- response = self._request(
1727
- "PATCH", "/v1/router", path={}, query=query, timeout=timeout, body=body
1728
- )
1729
- return response.json()
1730
-
1731
- def get_session_groups(
1732
- self, *, query: Query | None = None, timeout: float | None = None
1733
- ) -> _types.SessionGroupPage:
1734
- """GET /v1/session-groups — the groups of one project, in the human's order."""
1735
- response = self._request(
1736
- "GET", "/v1/session-groups", path={}, query=query, timeout=timeout
1737
- )
1738
- return response.json()
1739
-
1740
- def post_session_groups(
1741
- self,
1742
- *,
1743
- query: Query | None = None,
1744
- timeout: float | None = None,
1745
- body: JSONValue = None,
1746
- ) -> _types.SessionGroup:
1747
- """POST /v1/session-groups — create one group inside a project."""
1748
- response = self._request(
1749
- "POST",
1750
- "/v1/session-groups",
1751
- path={},
1752
- query=query,
1753
- timeout=timeout,
1754
- body=body,
1755
- )
1756
- return response.json()
1757
-
1758
- def delete_session_group(
1759
- self, gid: str, *, query: Query | None = None, timeout: float | None = None
1760
- ) -> _types.SessionGroupDeleted:
1761
- """DELETE /v1/session-groups/:gid — drop a group and say what becomes of it."""
1762
- response = self._request(
1763
- "DELETE",
1764
- "/v1/session-groups/:gid",
1765
- path={"gid": gid},
1766
- query=query,
1767
- timeout=timeout,
1768
- )
1769
- return response.json()
1770
-
1771
- def patch_session_group(
1772
- self,
1773
- gid: str,
1774
- *,
1775
- query: Query | None = None,
1776
- timeout: float | None = None,
1777
- body: JSONValue = None,
1778
- ) -> _types.SessionGroup:
1779
- """PATCH /v1/session-groups/:gid — rename, recolour or reorder a group."""
1780
- response = self._request(
1781
- "PATCH",
1782
- "/v1/session-groups/:gid",
1783
- path={"gid": gid},
1784
- query=query,
1785
- timeout=timeout,
1786
- body=body,
1787
- )
1788
- return response.json()
1789
-
1790
- def get_sessions(
1791
- self, *, query: Query | None = None, timeout: float | None = None
1792
- ) -> _types.SessionList:
1793
- """GET /v1/sessions — json response."""
1794
- response = self._request(
1795
- "GET", "/v1/sessions", path={}, query=query, timeout=timeout
1796
- )
1797
- return response.json()
1798
-
1799
- def post_sessions(
1800
- self,
1801
- *,
1802
- query: Query | None = None,
1803
- timeout: float | None = None,
1804
- body: JSONValue = None,
1805
- ) -> _types.Session:
1806
- """POST /v1/sessions — json response."""
1807
- response = self._request(
1808
- "POST", "/v1/sessions", path={}, query=query, timeout=timeout, body=body
1809
- )
1810
- return response.json()
1811
-
1812
- def delete_session(
1813
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
1814
- ) -> None:
1815
- """DELETE /v1/sessions/:sid — empty response."""
1816
- self._request(
1817
- "DELETE",
1818
- "/v1/sessions/:sid",
1819
- path={"sid": sid},
1820
- query=query,
1821
- timeout=timeout,
1822
- )
1823
- return None
1824
-
1825
- def get_session(
1826
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
1827
- ) -> _types.Session:
1828
- """GET /v1/sessions/:sid — json response."""
1829
- response = self._request(
1830
- "GET", "/v1/sessions/:sid", path={"sid": sid}, query=query, timeout=timeout
1831
- )
1832
- return response.json()
1833
-
1834
- def patch_session(
1835
- self,
1836
- sid: str,
1837
- *,
1838
- query: Query | None = None,
1839
- timeout: float | None = None,
1840
- body: JSONValue = None,
1841
- ) -> _types.Session:
1842
- """PATCH /v1/sessions/:sid — json response."""
1843
- response = self._request(
1844
- "PATCH",
1845
- "/v1/sessions/:sid",
1846
- path={"sid": sid},
1847
- query=query,
1848
- timeout=timeout,
1849
- body=body,
1850
- )
1851
- return response.json()
1852
-
1853
- def get_session_activity(
1854
- self,
1855
- sid: str,
1856
- aid: str,
1857
- *,
1858
- query: Query | None = None,
1859
- timeout: float | None = None,
1860
- ) -> _types.ActivityPage:
1861
- """GET /v1/sessions/:sid/activity/:aid — a bounded page of complete Activity records.
1862
-
1863
- Query with after, limit and q. Follow history.next_after until it is
1864
- null. When you combine pages into one copy, reject a changed revision.
1865
- """
1866
- response = self._request(
1867
- "GET",
1868
- "/v1/sessions/:sid/activity/:aid",
1869
- path={"sid": sid, "aid": aid},
1870
- query=query,
1871
- timeout=timeout,
1872
- )
1873
- return response.json()
1874
-
1875
- def get_session_activity_export(
1876
- self,
1877
- sid: str,
1878
- aid: str,
1879
- *,
1880
- query: Query | None = None,
1881
- timeout: float | None = None,
1882
- ) -> Response:
1883
- """GET /v1/sessions/:sid/activity/:aid/export — complete unfiltered Activity text.
1884
-
1885
- The gateway streams this response, and the returned Response buffers its
1886
- bytes. Supply revision to reject a changed history before the export
1887
- starts. Raises ProtocolError if a concurrent change marks the export
1888
- incomplete.
1889
- """
1890
- response = self._request(
1891
- "GET",
1892
- "/v1/sessions/:sid/activity/:aid/export",
1893
- path={"sid": sid, "aid": aid},
1894
- query=query,
1895
- timeout=timeout,
1896
- )
1897
- if response.content.endswith(
1898
- b"\n\nINCOMPLETE EXPORT: Activity changed. Reload and retry.\n"
1899
- ):
1900
- raise ProtocolError("Activity export is incomplete; reload and retry")
1901
- return response
1902
-
1903
- def get_session_alert(
1904
- self, sid: str, *, timeout: float | None = None
1905
- ) -> _types.SessionAlert:
1906
- """GET /v1/sessions/:sid/alert — the banner text for the latest turn."""
1907
- return self._request(
1908
- "GET",
1909
- "/v1/sessions/:sid/alert",
1910
- path={"sid": sid},
1911
- timeout=timeout,
1912
- ).json()
1913
-
1914
- def get_session_artifacts(
1915
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
1916
- ) -> _types.SessionArtifacts:
1917
- """GET /v1/sessions/:sid/artifacts — json response."""
1918
- response = self._request(
1919
- "GET",
1920
- "/v1/sessions/:sid/artifacts",
1921
- path={"sid": sid},
1922
- query=query,
1923
- timeout=timeout,
1924
- )
1925
- return response.json()
1926
-
1927
- def post_session_attachments(
1928
- self,
1929
- sid: str,
1930
- *,
1931
- query: Query | None = None,
1932
- timeout: float | None = None,
1933
- content: bytes | None,
1934
- ) -> _types.Upload:
1935
- """POST /v1/sessions/:sid/attachments — json response."""
1936
- response = self._request(
1937
- "POST",
1938
- "/v1/sessions/:sid/attachments",
1939
- path={"sid": sid},
1940
- query=query,
1941
- timeout=timeout,
1942
- content=content,
1943
- )
1944
- return response.json()
1945
-
1946
- def post_session_cancel_current(
1947
- self,
1948
- sid: str,
1949
- *,
1950
- query: Query | None = None,
1951
- timeout: float | None = None,
1952
- body: JSONValue = None,
1953
- ) -> _types.TurnCancel:
1954
- """POST /v1/sessions/:sid/cancel-current — json response."""
1955
- response = self._request(
1956
- "POST",
1957
- "/v1/sessions/:sid/cancel-current",
1958
- path={"sid": sid},
1959
- query=query,
1960
- timeout=timeout,
1961
- body=body,
1962
- )
1963
- return response.json()
1964
-
1965
- def get_session_context(
1966
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
1967
- ) -> _types.SessionContext:
1968
- """GET /v1/sessions/:sid/context — json response."""
1969
- response = self._request(
1970
- "GET",
1971
- "/v1/sessions/:sid/context",
1972
- path={"sid": sid},
1973
- query=query,
1974
- timeout=timeout,
1975
- )
1976
- return response.json()
1977
-
1978
- def post_session_drain_queue(
1979
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
1980
- ) -> _types.TurnQueueStep:
1981
- """POST /v1/sessions/:sid/drain-queue — json response."""
1982
- response = self._request(
1983
- "POST",
1984
- "/v1/sessions/:sid/drain-queue",
1985
- path={"sid": sid},
1986
- query=query,
1987
- timeout=timeout,
1988
- )
1989
- return response.json()
1990
-
1991
- def get_session_events_since(
1992
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
1993
- ) -> _types.SessionEvents:
1994
- """GET /v1/sessions/:sid/events-since — json response."""
1995
- response = self._request(
1996
- "GET",
1997
- "/v1/sessions/:sid/events-since",
1998
- path={"sid": sid},
1999
- query=query,
2000
- timeout=timeout,
2001
- )
2002
- return response.json()
2003
-
2004
- def get_session_forks(
2005
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2006
- ) -> _types.SessionForkTurns:
2007
- """GET /v1/sessions/:sid/forks — json response."""
2008
- response = self._request(
2009
- "GET",
2010
- "/v1/sessions/:sid/forks",
2011
- path={"sid": sid},
2012
- query=query,
2013
- timeout=timeout,
2014
- )
2015
- return response.json()
2016
-
2017
- def post_session_forks(
2018
- self,
2019
- sid: str,
2020
- *,
2021
- query: Query | None = None,
2022
- timeout: float | None = None,
2023
- body: JSONValue = None,
2024
- ) -> _types.SessionWrapped:
2025
- """POST /v1/sessions/:sid/forks — json response."""
2026
- response = self._request(
2027
- "POST",
2028
- "/v1/sessions/:sid/forks",
2029
- path={"sid": sid},
2030
- query=query,
2031
- timeout=timeout,
2032
- body=body,
2033
- )
2034
- return response.json()
2035
-
2036
- def post_session_fs_actions_open(
2037
- self,
2038
- sid: str,
2039
- *,
2040
- query: Query | None = None,
2041
- timeout: float | None = None,
2042
- body: JSONValue = None,
2043
- ) -> _types.SessionFsOpen:
2044
- """POST /v1/sessions/:sid/fs/actions/open — open one file in the editor."""
2045
- response = self._request(
2046
- "POST",
2047
- "/v1/sessions/:sid/fs/actions/open",
2048
- path={"sid": sid},
2049
- query=query,
2050
- timeout=timeout,
2051
- body=body,
2052
- )
2053
- return response.json()
2054
-
2055
- def get_session_fs_file(
2056
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2057
- ) -> _types.FilePreview:
2058
- """GET /v1/sessions/:sid/fs/file — preview one workspace file by its kind."""
2059
- response = self._request(
2060
- "GET",
2061
- "/v1/sessions/:sid/fs/file",
2062
- path={"sid": sid},
2063
- query=query,
2064
- timeout=timeout,
2065
- )
2066
- return response.json()
2067
-
2068
- def get_session_fs_file_content(
2069
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2070
- ) -> Response:
2071
- """GET /v1/sessions/:sid/fs/file/content — binary response.
2072
-
2073
- Stream one recording or clip. Pass the path, expires and ticket of the
2074
- content_url that the media preview of get_session_fs_file gives.
2075
- """
2076
- response = self._request(
2077
- "GET",
2078
- "/v1/sessions/:sid/fs/file/content",
2079
- path={"sid": sid},
2080
- query=query,
2081
- timeout=timeout,
2082
- )
2083
- return response
2084
-
2085
- def put_session_group(
2086
- self,
2087
- sid: str,
2088
- *,
2089
- query: Query | None = None,
2090
- timeout: float | None = None,
2091
- body: JSONValue = None,
2092
- ) -> _types.Session:
2093
- """PUT /v1/sessions/:sid/group — file this session under a group."""
2094
- response = self._request(
2095
- "PUT",
2096
- "/v1/sessions/:sid/group",
2097
- path={"sid": sid},
2098
- query=query,
2099
- timeout=timeout,
2100
- body=body,
2101
- )
2102
- return response.json()
2103
-
2104
- def get_session_iteration_attachments(
2105
- self,
2106
- sid: str,
2107
- iid: str,
2108
- idx: str,
2109
- *,
2110
- query: Query | None = None,
2111
- timeout: float | None = None,
2112
- ) -> Response:
2113
- """GET /v1/sessions/:sid/iterations/:iid/attachments/:idx — binary response."""
2114
- response = self._request(
2115
- "GET",
2116
- "/v1/sessions/:sid/iterations/:iid/attachments/:idx",
2117
- path={"sid": sid, "iid": iid, "idx": idx},
2118
- query=query,
2119
- timeout=timeout,
2120
- )
2121
- return response
2122
-
2123
- def get_session_iteration_attachment_link(
2124
- self,
2125
- sid: str,
2126
- iid: str,
2127
- idx: str,
2128
- *,
2129
- query: Query | None = None,
2130
- timeout: float | None = None,
2131
- ) -> _types.AttachmentLink:
2132
- """GET /v1/sessions/:sid/iterations/:iid/attachments/:idx/link — JSON response.
2133
-
2134
- Get a signed content_url for an attachment that keeps a reference to a
2135
- file on the gateway machine. A frame, a download link or another app
2136
- opens that address without the gateway token.
2137
- """
2138
- response = self._request(
2139
- "GET",
2140
- "/v1/sessions/:sid/iterations/:iid/attachments/:idx/link",
2141
- path={"sid": sid, "iid": iid, "idx": idx},
2142
- query=query,
2143
- timeout=timeout,
2144
- )
2145
- return response.json()
2146
-
2147
- def put_session_iteration_attachment_agent_note(
2148
- self,
2149
- sid: str,
2150
- iid: str,
2151
- idx: str,
2152
- *,
2153
- query: Query | None = None,
2154
- timeout: float | None = None,
2155
- body: JSONValue = None,
2156
- ) -> _types.AgentNote:
2157
- """PUT /v1/sessions/:sid/iterations/:iid/attachments/:idx/agent-note — set the note of an HTML page for the model."""
2158
- response = self._request(
2159
- "PUT",
2160
- "/v1/sessions/:sid/iterations/:iid/attachments/:idx/agent-note",
2161
- path={"sid": sid, "iid": iid, "idx": idx},
2162
- query=query,
2163
- timeout=timeout,
2164
- body=body,
2165
- )
2166
- return response.json()
2167
-
2168
- def get_session_model(
2169
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2170
- ) -> _types.SessionModel:
2171
- """GET /v1/sessions/:sid/model — json response."""
2172
- response = self._request(
2173
- "GET",
2174
- "/v1/sessions/:sid/model",
2175
- path={"sid": sid},
2176
- query=query,
2177
- timeout=timeout,
2178
- )
2179
- return response.json()
2180
-
2181
- def patch_session_model(
2182
- self,
2183
- sid: str,
2184
- *,
2185
- query: Query | None = None,
2186
- timeout: float | None = None,
2187
- body: JSONValue = None,
2188
- ) -> _types.SessionModel:
2189
- """PATCH /v1/sessions/:sid/model — json response."""
2190
- response = self._request(
2191
- "PATCH",
2192
- "/v1/sessions/:sid/model",
2193
- path={"sid": sid},
2194
- query=query,
2195
- timeout=timeout,
2196
- body=body,
2197
- )
2198
- return response.json()
2199
-
2200
- def post_session_queue_send_now(
2201
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2202
- ) -> _types.QueueSendNow:
2203
- """POST /v1/sessions/:sid/queue/send-now — json response."""
2204
- response = self._request(
2205
- "POST",
2206
- "/v1/sessions/:sid/queue/send-now",
2207
- path={"sid": sid},
2208
- query=query,
2209
- timeout=timeout,
2210
- )
2211
- return response.json()
2212
-
2213
- def put_session_read(
2214
- self,
2215
- sid: str,
2216
- *,
2217
- query: Query | None = None,
2218
- timeout: float | None = None,
2219
- body: JSONValue = None,
2220
- ) -> _types.SessionRead:
2221
- """PUT /v1/sessions/:sid/read — how far this reader has read the session."""
2222
- response = self._request(
2223
- "PUT",
2224
- "/v1/sessions/:sid/read",
2225
- path={"sid": sid},
2226
- query=query,
2227
- timeout=timeout,
2228
- body=body,
2229
- )
2230
- return response.json()
2231
-
2232
- def post_session_release(
2233
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2234
- ) -> None:
2235
- """POST /v1/sessions/:sid/release — empty response."""
2236
- self._request(
2237
- "POST",
2238
- "/v1/sessions/:sid/release",
2239
- path={"sid": sid},
2240
- query=query,
2241
- timeout=timeout,
2242
- )
2243
- return None
2244
-
2245
- def get_session_resources(
2246
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2247
- ) -> _types.SessionResources:
2248
- """GET /v1/sessions/:sid/resources — json response."""
2249
- response = self._request(
2250
- "GET",
2251
- "/v1/sessions/:sid/resources",
2252
- path={"sid": sid},
2253
- query=query,
2254
- timeout=timeout,
2255
- )
2256
- return response.json()
2257
-
2258
- def get_session_resources_logs(
2259
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2260
- ) -> _types.SessionResourceLogs:
2261
- """GET /v1/sessions/:sid/resources/logs — json response."""
2262
- response = self._request(
2263
- "GET",
2264
- "/v1/sessions/:sid/resources/logs",
2265
- path={"sid": sid},
2266
- query=query,
2267
- timeout=timeout,
2268
- )
2269
- return response.json()
2270
-
2271
- def post_session_resources_stop(
2272
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2273
- ) -> _types.SessionResourceStop:
2274
- """POST /v1/sessions/:sid/resources/stop — json response."""
2275
- response = self._request(
2276
- "POST",
2277
- "/v1/sessions/:sid/resources/stop",
2278
- path={"sid": sid},
2279
- query=query,
2280
- timeout=timeout,
2281
- )
2282
- return response.json()
2283
-
2284
- def post_session_resume_queue(
2285
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2286
- ) -> _types.TurnQueueStep:
2287
- """POST /v1/sessions/:sid/resume-queue — json response."""
2288
- response = self._request(
2289
- "POST",
2290
- "/v1/sessions/:sid/resume-queue",
2291
- path={"sid": sid},
2292
- query=query,
2293
- timeout=timeout,
2294
- )
2295
- return response.json()
2296
-
2297
- def get_session_seq(
2298
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2299
- ) -> _types.SessionSeq:
2300
- """GET /v1/sessions/:sid/seq — json response."""
2301
- response = self._request(
2302
- "GET",
2303
- "/v1/sessions/:sid/seq",
2304
- path={"sid": sid},
2305
- query=query,
2306
- timeout=timeout,
2307
- )
2308
- return response.json()
2309
-
2310
- def get_session_slashes(
2311
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2312
- ) -> _types.SessionSlashes:
2313
- """GET /v1/sessions/:sid/slashes — json response."""
2314
- response = self._request(
2315
- "GET",
2316
- "/v1/sessions/:sid/slashes",
2317
- path={"sid": sid},
2318
- query=query,
2319
- timeout=timeout,
2320
- )
2321
- return response.json()
2322
-
2323
- def get_session_keybindings(
2324
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2325
- ) -> _types.KeybindingList:
2326
- """GET /v1/sessions/:sid/keybindings — json response."""
2327
- response = self._request(
2328
- "GET",
2329
- "/v1/sessions/:sid/keybindings",
2330
- path={"sid": sid},
2331
- query=query,
2332
- timeout=timeout,
2333
- )
2334
- return response.json()
2335
-
2336
- def post_session_keybindings_run(
2337
- self,
2338
- sid: str,
2339
- *,
2340
- query: Query | None = None,
2341
- timeout: float | None = None,
2342
- body: JSONValue = None,
2343
- ) -> _types.KeybindingRunResult:
2344
- """POST /v1/sessions/:sid/keybindings/run — json response."""
2345
- response = self._request(
2346
- "POST",
2347
- "/v1/sessions/:sid/keybindings/run",
2348
- path={"sid": sid},
2349
- query=query,
2350
- timeout=timeout,
2351
- body=body,
2352
- )
2353
- return response.json()
2354
-
2355
- def get_session_snapshot(
2356
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2357
- ) -> Response:
2358
- """GET /v1/sessions/:sid/snapshot — binary response."""
2359
- response = self._request(
2360
- "GET",
2361
- "/v1/sessions/:sid/snapshot",
2362
- path={"sid": sid},
2363
- query=query,
2364
- timeout=timeout,
2365
- )
2366
- return response
2367
-
2368
- def post_session_speech(
2369
- self,
2370
- sid: str,
2371
- *,
2372
- query: Query | None = None,
2373
- timeout: float | None = None,
2374
- body: JSONValue = None,
2375
- ) -> _types.VoiceJob:
2376
- """POST /v1/sessions/:sid/speech — json response."""
2377
- response = self._request(
2378
- "POST",
2379
- "/v1/sessions/:sid/speech",
2380
- path={"sid": sid},
2381
- query=query,
2382
- timeout=timeout,
2383
- body=body,
2384
- )
2385
- return response.json()
2386
-
2387
- def delete_session_speech_job(
2388
- self,
2389
- sid: str,
2390
- job_id: str,
2391
- *,
2392
- query: Query | None = None,
2393
- timeout: float | None = None,
2394
- ) -> _types.Forgotten:
2395
- """DELETE /v1/sessions/:sid/speech/jobs/:job-id — json response."""
2396
- response = self._request(
2397
- "DELETE",
2398
- "/v1/sessions/:sid/speech/jobs/:job-id",
2399
- path={"sid": sid, "job-id": job_id},
2400
- query=query,
2401
- timeout=timeout,
2402
- )
2403
- return response.json()
2404
-
2405
- def get_session_speech_job(
2406
- self,
2407
- sid: str,
2408
- job_id: str,
2409
- *,
2410
- query: Query | None = None,
2411
- timeout: float | None = None,
2412
- ) -> _types.VoiceJob:
2413
- """GET /v1/sessions/:sid/speech/jobs/:job-id — json response."""
2414
- response = self._request(
2415
- "GET",
2416
- "/v1/sessions/:sid/speech/jobs/:job-id",
2417
- path={"sid": sid, "job-id": job_id},
2418
- query=query,
2419
- timeout=timeout,
2420
- )
2421
- return response.json()
2422
-
2423
- def get_session_speech_job_audio(
2424
- self,
2425
- sid: str,
2426
- job_id: str,
2427
- *,
2428
- query: Query | None = None,
2429
- timeout: float | None = None,
2430
- ) -> Response:
2431
- """GET /v1/sessions/:sid/speech/jobs/:job-id/audio — binary response."""
2432
- response = self._request(
2433
- "GET",
2434
- "/v1/sessions/:sid/speech/jobs/:job-id/audio",
2435
- path={"sid": sid, "job-id": job_id},
2436
- query=query,
2437
- timeout=timeout,
2438
- )
2439
- return response
2440
-
2441
- def get_session_suggest(
2442
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2443
- ) -> _types.SessionSuggestions:
2444
- """GET /v1/sessions/:sid/suggest — json response."""
2445
- response = self._request(
2446
- "GET",
2447
- "/v1/sessions/:sid/suggest",
2448
- path={"sid": sid},
2449
- query=query,
2450
- timeout=timeout,
2451
- )
2452
- return response.json()
2453
-
2454
- def get_session_transcript(
2455
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2456
- ) -> _types.Transcript:
2457
- """GET /v1/sessions/:sid/transcript — json response."""
2458
- response = self._request(
2459
- "GET",
2460
- "/v1/sessions/:sid/transcript",
2461
- path={"sid": sid},
2462
- query=query,
2463
- timeout=timeout,
2464
- )
2465
- return response.json()
2466
-
2467
- def get_session_transcript_html(
2468
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2469
- ) -> Response:
2470
- """GET /v1/sessions/:sid/transcript.html — html response."""
2471
- response = self._request(
2472
- "GET",
2473
- "/v1/sessions/:sid/transcript.html",
2474
- path={"sid": sid},
2475
- query=query,
2476
- timeout=timeout,
2477
- )
2478
- return response
2479
-
2480
- def get_session_transcript_md(
2481
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2482
- ) -> Response:
2483
- """GET /v1/sessions/:sid/transcript.md — markdown response."""
2484
- response = self._request(
2485
- "GET",
2486
- "/v1/sessions/:sid/transcript.md",
2487
- path={"sid": sid},
2488
- query=query,
2489
- timeout=timeout,
2490
- )
2491
- return response
2492
-
2493
- def get_session_turns(
2494
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2495
- ) -> _types.TurnList:
2496
- """GET /v1/sessions/:sid/turns — json response."""
2497
- response = self._request(
2498
- "GET",
2499
- "/v1/sessions/:sid/turns",
2500
- path={"sid": sid},
2501
- query=query,
2502
- timeout=timeout,
2503
- )
2504
- return response.json()
2505
-
2506
- def post_session_turns(
2507
- self,
2508
- sid: str,
2509
- *,
2510
- query: Query | None = None,
2511
- timeout: float | None = None,
2512
- body: JSONValue = None,
2513
- ) -> _types.Turn:
2514
- """POST /v1/sessions/:sid/turns — json response."""
2515
- response = self._request(
2516
- "POST",
2517
- "/v1/sessions/:sid/turns",
2518
- path={"sid": sid},
2519
- query=query,
2520
- timeout=timeout,
2521
- body=body,
2522
- )
2523
- return response.json()
2524
-
2525
- def delete_session_turn(
2526
- self,
2527
- sid: str,
2528
- tid: str,
2529
- *,
2530
- query: Query | None = None,
2531
- timeout: float | None = None,
2532
- ) -> _types.TurnCancel:
2533
- """DELETE /v1/sessions/:sid/turns/:tid — json response."""
2534
- response = self._request(
2535
- "DELETE",
2536
- "/v1/sessions/:sid/turns/:tid",
2537
- path={"sid": sid, "tid": tid},
2538
- query=query,
2539
- timeout=timeout,
2540
- )
2541
- return response.json()
2542
-
2543
- def get_session_turn(
2544
- self,
2545
- sid: str,
2546
- tid: str,
2547
- *,
2548
- query: Query | None = None,
2549
- timeout: float | None = None,
2550
- ) -> _types.Turn:
2551
- """GET /v1/sessions/:sid/turns/:tid — json response."""
2552
- response = self._request(
2553
- "GET",
2554
- "/v1/sessions/:sid/turns/:tid",
2555
- path={"sid": sid, "tid": tid},
2556
- query=query,
2557
- timeout=timeout,
2558
- )
2559
- return response.json()
2560
-
2561
- def patch_session_turn(
2562
- self,
2563
- sid: str,
2564
- tid: str,
2565
- *,
2566
- query: Query | None = None,
2567
- timeout: float | None = None,
2568
- body: JSONValue = None,
2569
- ) -> _types.Turn:
2570
- """PATCH /v1/sessions/:sid/turns/:tid — json response."""
2571
- response = self._request(
2572
- "PATCH",
2573
- "/v1/sessions/:sid/turns/:tid",
2574
- path={"sid": sid, "tid": tid},
2575
- query=query,
2576
- timeout=timeout,
2577
- body=body,
2578
- )
2579
- return response.json()
2580
-
2581
- def get_session_turn_attachments(
2582
- self,
2583
- sid: str,
2584
- tid: str,
2585
- *,
2586
- query: Query | None = None,
2587
- timeout: float | None = None,
2588
- ) -> _types.TurnAttachments:
2589
- """GET /v1/sessions/:sid/turns/:tid/attachments — json response."""
2590
- response = self._request(
2591
- "GET",
2592
- "/v1/sessions/:sid/turns/:tid/attachments",
2593
- path={"sid": sid, "tid": tid},
2594
- query=query,
2595
- timeout=timeout,
2596
- )
2597
- return response.json()
2598
-
2599
- def post_session_turn_cancel(
2600
- self,
2601
- sid: str,
2602
- tid: str,
2603
- *,
2604
- query: Query | None = None,
2605
- timeout: float | None = None,
2606
- ) -> _types.TurnCancel:
2607
- """POST /v1/sessions/:sid/turns/:tid/cancel — json response."""
2608
- response = self._request(
2609
- "POST",
2610
- "/v1/sessions/:sid/turns/:tid/cancel",
2611
- path={"sid": sid, "tid": tid},
2612
- query=query,
2613
- timeout=timeout,
2614
- )
2615
- return response.json()
2616
-
2617
- def get_session_turn_trace(
2618
- self,
2619
- sid: str,
2620
- tid: str,
2621
- *,
2622
- query: Query | None = None,
2623
- timeout: float | None = None,
2624
- ) -> _types.TurnTrace:
2625
- """GET /v1/sessions/:sid/turns/:tid/trace — json response."""
2626
- response = self._request(
2627
- "GET",
2628
- "/v1/sessions/:sid/turns/:tid/trace",
2629
- path={"sid": sid, "tid": tid},
2630
- query=query,
2631
- timeout=timeout,
2632
- )
2633
- return response.json()
2634
-
2635
- def get_session_usage(
2636
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2637
- ) -> _types.SessionUsage:
2638
- """GET /v1/sessions/:sid/usage — json response."""
2639
- response = self._request(
2640
- "GET",
2641
- "/v1/sessions/:sid/usage",
2642
- path={"sid": sid},
2643
- query=query,
2644
- timeout=timeout,
2645
- )
2646
- return response.json()
2647
-
2648
- def post_session_view(
2649
- self,
2650
- sid: str,
2651
- view_id: str,
2652
- *,
2653
- query: Query | None = None,
2654
- timeout: float | None = None,
2655
- body: JSONValue = None,
2656
- ) -> _types.ViewOutcome:
2657
- """POST /v1/sessions/:sid/views/:view-id/actions — json response."""
2658
- response = self._request(
2659
- "POST",
2660
- "/v1/sessions/:sid/views/:view-id/actions",
2661
- path={"sid": sid, "view-id": view_id},
2662
- query=query,
2663
- timeout=timeout,
2664
- body=body,
2665
- )
2666
- return response.json()
2667
-
2668
- def get_session_views_input(
2669
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2670
- ) -> _types.ViewRequests:
2671
- """GET /v1/sessions/:sid/views/input — json response."""
2672
- response = self._request(
2673
- "GET",
2674
- "/v1/sessions/:sid/views/input",
2675
- path={"sid": sid},
2676
- query=query,
2677
- timeout=timeout,
2678
- )
2679
- return response.json()
2680
-
2681
- def get_session_views_live(
2682
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2683
- ) -> _types.AppList:
2684
- """GET /v1/sessions/:sid/views/live — json response."""
2685
- response = self._request(
2686
- "GET",
2687
- "/v1/sessions/:sid/views/live",
2688
- path={"sid": sid},
2689
- query=query,
2690
- timeout=timeout,
2691
- )
2692
- return response.json()
2693
-
2694
- def get_session_views_live_view(
2695
- self,
2696
- sid: str,
2697
- view_id: str,
2698
- *,
2699
- query: Query | None = None,
2700
- timeout: float | None = None,
2701
- ) -> _types.AppView:
2702
- """GET /v1/sessions/:sid/views/live/:view-id — json response."""
2703
- response = self._request(
2704
- "GET",
2705
- "/v1/sessions/:sid/views/live/:view-id",
2706
- path={"sid": sid, "view-id": view_id},
2707
- query=query,
2708
- timeout=timeout,
2709
- )
2710
- return response.json()
2711
-
2712
- def get_session_views_live_log(
2713
- self,
2714
- sid: str,
2715
- view_id: str,
2716
- node_id: str,
2717
- *,
2718
- query: Query | None = None,
2719
- timeout: float | None = None,
2720
- ) -> _types.ViewLog:
2721
- """GET /v1/sessions/:sid/views/live/:view-id/log — json response.
2722
-
2723
- The node rides the query string: node ids are free text a surface chose
2724
- and may hold ``/``, which a path segment cannot carry.
2725
- """
2726
- response = self._request(
2727
- "GET",
2728
- "/v1/sessions/:sid/views/live/:view-id/log",
2729
- path={"sid": sid, "view-id": view_id},
2730
- query={"node": node_id, **(query or {})},
2731
- timeout=timeout,
2732
- )
2733
- return response.json()
2734
-
2735
- def post_session_apps(
2736
- self,
2737
- sid: str,
2738
- *,
2739
- query: Query | None = None,
2740
- timeout: float | None = None,
2741
- body: JSONValue = None,
2742
- ) -> _types.AppDoorAnswer:
2743
- """POST /v1/sessions/:sid/apps — json response."""
2744
- response = self._request(
2745
- "POST",
2746
- "/v1/sessions/:sid/apps",
2747
- path={"sid": sid},
2748
- query=query,
2749
- timeout=timeout,
2750
- body=body,
2751
- )
2752
- return response.json()
2753
-
2754
- def get_apps(
2755
- self, *, query: Query | None = None, timeout: float | None = None
2756
- ) -> _types.AppList:
2757
- """GET /v1/apps — json response."""
2758
- response = self._request(
2759
- "GET", "/v1/apps", path={}, query=query, timeout=timeout
2760
- )
2761
- return response.json()
2762
-
2763
- def post_apps(
2764
- self,
2765
- *,
2766
- query: Query | None = None,
2767
- timeout: float | None = None,
2768
- body: JSONValue = None,
2769
- ) -> _types.AppDoorAnswer:
2770
- """POST /v1/apps — json response."""
2771
- response = self._request(
2772
- "POST", "/v1/apps", path={}, query=query, timeout=timeout, body=body
2773
- )
2774
- return response.json()
2775
-
2776
- def get_app(
2777
- self, view_id: str, *, query: Query | None = None, timeout: float | None = None
2778
- ) -> _types.AppView:
2779
- """GET /v1/apps/:view-id — json response."""
2780
- response = self._request(
2781
- "GET",
2782
- "/v1/apps/:view-id",
2783
- path={"view-id": view_id},
2784
- query=query,
2785
- timeout=timeout,
2786
- )
2787
- return response.json()
2788
-
2789
- def post_app_actions(
2790
- self,
2791
- view_id: str,
2792
- *,
2793
- query: Query | None = None,
2794
- timeout: float | None = None,
2795
- body: JSONValue = None,
2796
- ) -> _types.ViewOutcome:
2797
- """POST /v1/apps/:view-id/actions — json response."""
2798
- response = self._request(
2799
- "POST",
2800
- "/v1/apps/:view-id/actions",
2801
- path={"view-id": view_id},
2802
- query=query,
2803
- timeout=timeout,
2804
- body=body,
2805
- )
2806
- return response.json()
2807
-
2808
- def get_web_brand(
2809
- self, *, query: Query | None = None, timeout: float | None = None
2810
- ) -> _types.WebBrand:
2811
- """GET /v1/web/brand — json response."""
2812
- response = self._request(
2813
- "GET", "/v1/web/brand", path={}, query=query, timeout=timeout
2814
- )
2815
- return response.json()
2816
-
2817
- def put_web_brand(
2818
- self,
2819
- *,
2820
- query: Query | None = None,
2821
- timeout: float | None = None,
2822
- body: JSONValue = None,
2823
- ) -> _types.WebBrand:
2824
- """PUT /v1/web/brand — json response."""
2825
- response = self._request(
2826
- "PUT", "/v1/web/brand", path={}, query=query, timeout=timeout, body=body
2827
- )
2828
- return response.json()
2829
-
2830
- def delete_web_brand(
2831
- self, *, query: Query | None = None, timeout: float | None = None
2832
- ) -> None:
2833
- """DELETE /v1/web/brand — empty response."""
2834
- self._request("DELETE", "/v1/web/brand", path={}, query=query, timeout=timeout)
2835
- return None
2836
-
2837
- def post_session_voice(
2838
- self,
2839
- sid: str,
2840
- *,
2841
- query: Query | None = None,
2842
- timeout: float | None = None,
2843
- content: bytes | None,
2844
- ) -> _types.VoiceJob:
2845
- """POST /v1/sessions/:sid/voice — json response."""
2846
- response = self._request(
2847
- "POST",
2848
- "/v1/sessions/:sid/voice",
2849
- path={"sid": sid},
2850
- query=query,
2851
- timeout=timeout,
2852
- content=content,
2853
- )
2854
- return response.json()
2855
-
2856
- def delete_session_voice_job(
2857
- self,
2858
- sid: str,
2859
- job_id: str,
2860
- *,
2861
- query: Query | None = None,
2862
- timeout: float | None = None,
2863
- ) -> _types.Forgotten:
2864
- """DELETE /v1/sessions/:sid/voice/jobs/:job-id — json response."""
2865
- response = self._request(
2866
- "DELETE",
2867
- "/v1/sessions/:sid/voice/jobs/:job-id",
2868
- path={"sid": sid, "job-id": job_id},
2869
- query=query,
2870
- timeout=timeout,
2871
- )
2872
- return response.json()
2873
-
2874
- def get_session_voice_job(
2875
- self,
2876
- sid: str,
2877
- job_id: str,
2878
- *,
2879
- query: Query | None = None,
2880
- timeout: float | None = None,
2881
- ) -> _types.VoiceJob:
2882
- """GET /v1/sessions/:sid/voice/jobs/:job-id — json response."""
2883
- response = self._request(
2884
- "GET",
2885
- "/v1/sessions/:sid/voice/jobs/:job-id",
2886
- path={"sid": sid, "job-id": job_id},
2887
- query=query,
2888
- timeout=timeout,
2889
- )
2890
- return response.json()
2891
-
2892
- def get_session_workspace(
2893
- self, sid: str, *, query: Query | None = None, timeout: float | None = None
2894
- ) -> _types.SessionWorkspace:
2895
- """GET /v1/sessions/:sid/workspace — json response."""
2896
- response = self._request(
2897
- "GET",
2898
- "/v1/sessions/:sid/workspace",
2899
- path={"sid": sid},
2900
- query=query,
2901
- timeout=timeout,
2902
- )
2903
- return response.json()
2904
-
2905
- def patch_session_workspace_root(
2906
- self,
2907
- sid: str,
2908
- *,
2909
- query: Query | None = None,
2910
- timeout: float | None = None,
2911
- body: JSONValue = None,
2912
- ) -> _types.SessionWorkspace:
2913
- """PATCH /v1/sessions/:sid/workspace/root — json response."""
2914
- response = self._request(
2915
- "PATCH",
2916
- "/v1/sessions/:sid/workspace/root",
2917
- path={"sid": sid},
2918
- query=query,
2919
- timeout=timeout,
2920
- body=body,
2921
- )
2922
- return response.json()
2923
-
2924
- def post_sessions_archive(
2925
- self,
2926
- *,
2927
- query: Query | None = None,
2928
- timeout: float | None = None,
2929
- body: JSONValue = None,
2930
- ) -> _types.SessionArchive:
2931
- """POST /v1/sessions/actions/archive — archive many sessions; skip working ones."""
2932
- response = self._request(
2933
- "POST",
2934
- "/v1/sessions/actions/archive",
2935
- path={},
2936
- query=query,
2937
- timeout=timeout,
2938
- body=body,
2939
- )
2940
- return response.json()
2941
-
2942
- def post_sessions_import(
2943
- self,
2944
- *,
2945
- query: Query | None = None,
2946
- timeout: float | None = None,
2947
- content: bytes | None,
2948
- ) -> _types.Session:
2949
- """POST /v1/sessions/actions/import — restore a session snapshot."""
2950
- response = self._request(
2951
- "POST",
2952
- "/v1/sessions/actions/import",
2953
- path={},
2954
- query=query,
2955
- timeout=timeout,
2956
- content=content,
2957
- )
2958
- return response.json()
2959
-
2960
- def get_sessions_search(
2961
- self, *, query: Query | None = None, timeout: float | None = None
2962
- ) -> _types.SessionSearch:
2963
- """GET /v1/sessions/actions/search — json response."""
2964
- response = self._request(
2965
- "GET", "/v1/sessions/actions/search", path={}, query=query, timeout=timeout
2966
- )
2967
- return response.json()
2968
-
2969
- def post_machines_order(
2970
- self,
2971
- *,
2972
- query: Query | None = None,
2973
- timeout: float | None = None,
2974
- body: JSONValue = None,
2975
- ) -> _types.MachineOrder:
2976
- """POST /v1/machines/order — register gateway IDs and return their durable order."""
2977
- response = self._request(
2978
- "POST",
2979
- "/v1/machines/order",
2980
- path={},
2981
- query=query,
2982
- timeout=timeout,
2983
- body=body,
2984
- )
2985
- return response.json()
2986
-
2987
- def get_automations(
2988
- self, *, query: Query | None = None, timeout: float | None = None
2989
- ) -> _types.AutomationsList:
2990
- """GET /v1/automations — json response."""
2991
- response = self._request(
2992
- "GET", "/v1/automations", path={}, query=query, timeout=timeout
2993
- )
2994
- return response.json()
2995
-
2996
- def post_automations(
2997
- self,
2998
- *,
2999
- query: Query | None = None,
3000
- timeout: float | None = None,
3001
- body: JSONValue = None,
3002
- ) -> _types.AutomationsAutomation:
3003
- """POST /v1/automations — json response."""
3004
- response = self._request(
3005
- "POST", "/v1/automations", path={}, query=query, timeout=timeout, body=body
3006
- )
3007
- return response.json()
3008
-
3009
- def get_automation_runs(
3010
- self, *, query: Query | None = None, timeout: float | None = None
3011
- ) -> _types.AutomationsRunList:
3012
- """GET /v1/automations/runs — json response."""
3013
- response = self._request(
3014
- "GET", "/v1/automations/runs", path={}, query=query, timeout=timeout
3015
- )
3016
- return response.json()
3017
-
3018
- def get_automation_run(
3019
- self, run_id: str, *, query: Query | None = None, timeout: float | None = None
3020
- ) -> _types.AutomationsRun:
3021
- """GET /v1/automations/runs/:run-id — json response."""
3022
- response = self._request(
3023
- "GET",
3024
- "/v1/automations/runs/:run-id",
3025
- path={"run-id": run_id},
3026
- query=query,
3027
- timeout=timeout,
3028
- )
3029
- return response.json()
3030
-
3031
- def get_automation(
3032
- self,
3033
- automation_id: str,
3034
- *,
3035
- query: Query | None = None,
3036
- timeout: float | None = None,
3037
- ) -> _types.AutomationsAutomation:
3038
- """GET /v1/automations/:automation-id — json response."""
3039
- response = self._request(
3040
- "GET",
3041
- "/v1/automations/:automation-id",
3042
- path={"automation-id": automation_id},
3043
- query=query,
3044
- timeout=timeout,
3045
- )
3046
- return response.json()
3047
-
3048
- def patch_automation(
3049
- self,
3050
- automation_id: str,
3051
- *,
3052
- query: Query | None = None,
3053
- timeout: float | None = None,
3054
- body: JSONValue = None,
3055
- ) -> _types.AutomationsAutomation:
3056
- """PATCH /v1/automations/:automation-id — json response."""
3057
- response = self._request(
3058
- "PATCH",
3059
- "/v1/automations/:automation-id",
3060
- path={"automation-id": automation_id},
3061
- query=query,
3062
- timeout=timeout,
3063
- body=body,
3064
- )
3065
- return response.json()
3066
-
3067
- def delete_automation(
3068
- self,
3069
- automation_id: str,
3070
- *,
3071
- query: Query | None = None,
3072
- timeout: float | None = None,
3073
- ) -> _types.AutomationsDeleted:
3074
- """DELETE /v1/automations/:automation-id — json response."""
3075
- response = self._request(
3076
- "DELETE",
3077
- "/v1/automations/:automation-id",
3078
- path={"automation-id": automation_id},
3079
- query=query,
3080
- timeout=timeout,
3081
- )
3082
- return response.json()
3083
-
3084
- def post_automation_run(
3085
- self,
3086
- automation_id: str,
3087
- *,
3088
- query: Query | None = None,
3089
- timeout: float | None = None,
3090
- ) -> _types.AutomationsRun:
3091
- """POST /v1/automations/:automation-id/run — json response."""
3092
- response = self._request(
3093
- "POST",
3094
- "/v1/automations/:automation-id/run",
3095
- path={"automation-id": automation_id},
3096
- query=query,
3097
- timeout=timeout,
3098
- )
3099
- return response.json()
3100
-
3101
- def post_automation_secrets(
3102
- self,
3103
- automation_id: str,
3104
- *,
3105
- query: Query | None = None,
3106
- timeout: float | None = None,
3107
- body: JSONValue = None,
3108
- ) -> _types.AutomationsSecretCreated:
3109
- """POST /v1/automations/:automation-id/secrets — json response."""
3110
- response = self._request(
3111
- "POST",
3112
- "/v1/automations/:automation-id/secrets",
3113
- path={"automation-id": automation_id},
3114
- query=query,
3115
- timeout=timeout,
3116
- body=body,
3117
- )
3118
- return response.json()
3119
-
3120
- def post_evals_agreement(
3121
- self,
3122
- *,
3123
- query: Query | None = None,
3124
- timeout: float | None = None,
3125
- body: JSONValue = None,
3126
- ) -> _types.EvalsAgreement:
3127
- """POST /v1/evals/agreement — json response."""
3128
- response = self._request(
3129
- "POST",
3130
- "/v1/evals/agreement",
3131
- path={},
3132
- query=query,
3133
- timeout=timeout,
3134
- body=body,
3135
- )
3136
- return response.json()
3137
-
3138
- def post_evals_compare(
3139
- self,
3140
- *,
3141
- query: Query | None = None,
3142
- timeout: float | None = None,
3143
- body: JSONValue = None,
3144
- ) -> _types.EvalsCaseComparison:
3145
- """POST /v1/evals/compare — json response."""
3146
- response = self._request(
3147
- "POST",
3148
- "/v1/evals/compare",
3149
- path={},
3150
- query=query,
3151
- timeout=timeout,
3152
- body=body,
3153
- )
3154
- return response.json()
3155
-
3156
- def post_evals_diagnose(
3157
- self,
3158
- *,
3159
- query: Query | None = None,
3160
- timeout: float | None = None,
3161
- body: JSONValue = None,
3162
- ) -> _types.EvalsDiagnosis:
3163
- """POST /v1/evals/diagnose — json response."""
3164
- response = self._request(
3165
- "POST",
3166
- "/v1/evals/diagnose",
3167
- path={},
3168
- query=query,
3169
- timeout=timeout,
3170
- body=body,
3171
- )
3172
- return response.json()
3173
-
3174
- def post_evals_labels(
3175
- self,
3176
- *,
3177
- query: Query | None = None,
3178
- timeout: float | None = None,
3179
- body: JSONValue = None,
3180
- ) -> _types.EvalsAgreement:
3181
- """POST /v1/evals/labels — json response."""
3182
- response = self._request(
3183
- "POST", "/v1/evals/labels", path={}, query=query, timeout=timeout, body=body
3184
- )
3185
- return response.json()
3186
-
3187
- def post_evals_leaderboard(
3188
- self,
3189
- *,
3190
- query: Query | None = None,
3191
- timeout: float | None = None,
3192
- body: JSONValue = None,
3193
- ) -> _types.EvalsLeaderboard:
3194
- """POST /v1/evals/leaderboard — json response."""
3195
- response = self._request(
3196
- "POST",
3197
- "/v1/evals/leaderboard",
3198
- path={},
3199
- query=query,
3200
- timeout=timeout,
3201
- body=body,
3202
- )
3203
- return response.json()
3204
-
3205
- def post_evals_report(
3206
- self,
3207
- *,
3208
- query: Query | None = None,
3209
- timeout: float | None = None,
3210
- body: JSONValue = None,
3211
- ) -> _types.EvalsBenchReport:
3212
- """POST /v1/evals/report — json response."""
3213
- response = self._request(
3214
- "POST", "/v1/evals/report", path={}, query=query, timeout=timeout, body=body
3215
- )
3216
- return response.json()
3217
-
3218
- def get_settings(
3219
- self, *, query: Query | None = None, timeout: float | None = None
3220
- ) -> _types.Settings:
3221
- """GET /v1/settings — json response."""
3222
- response = self._request(
3223
- "GET", "/v1/settings", path={}, query=query, timeout=timeout
3224
- )
3225
- return response.json()
3226
-
3227
- def post_settings(
3228
- self,
3229
- *,
3230
- query: Query | None = None,
3231
- timeout: float | None = None,
3232
- body: JSONValue = None,
3233
- ) -> _types.Setting:
3234
- """POST /v1/settings — json response."""
3235
- response = self._request(
3236
- "POST", "/v1/settings", path={}, query=query, timeout=timeout, body=body
3237
- )
3238
- return response.json()
3239
-
3240
- def patch_settings(
3241
- self,
3242
- *,
3243
- query: Query | None = None,
3244
- timeout: float | None = None,
3245
- body: JSONValue = None,
3246
- ) -> _types.Settings:
3247
- """PATCH /v1/settings — json response."""
3248
- response = self._request(
3249
- "PATCH", "/v1/settings", path={}, query=query, timeout=timeout, body=body
3250
- )
3251
- return response.json()
3252
-
3253
- def get_setting(
3254
- self, id: str, *, query: Query | None = None, timeout: float | None = None
3255
- ) -> _types.Setting:
3256
- """GET /v1/settings/:id — json response."""
3257
- response = self._request(
3258
- "GET", "/v1/settings/:id", path={"id": id}, query=query, timeout=timeout
3259
- )
3260
- return response.json()
3261
-
3262
- def post_setting_preview(
3263
- self,
3264
- id: str,
3265
- *,
3266
- query: Query | None = None,
3267
- timeout: float | None = None,
3268
- body: JSONValue = None,
3269
- ) -> _types.SettingPreviewResult:
3270
- """POST /v1/settings/:id/preview — json response."""
3271
- response = self._request(
3272
- "POST",
3273
- "/v1/settings/:id/preview",
3274
- path={"id": id},
3275
- query=query,
3276
- timeout=timeout,
3277
- body=body,
3278
- )
3279
- return response.json()
3280
-
3281
- def post_extensions_reload(
3282
- self,
3283
- *,
3284
- query: Query | None = None,
3285
- timeout: float | None = None,
3286
- body: JSONValue = None,
3287
- ) -> _types.ExtensionReload:
3288
- """POST /v1/extensions/reload — json response."""
3289
- response = self._request(
3290
- "POST",
3291
- "/v1/extensions/reload",
3292
- path={},
3293
- query=query,
3294
- timeout=timeout,
3295
- body=body,
3296
- )
3297
- return response.json()
3298
-
3299
- def post_speech(
3300
- self,
3301
- *,
3302
- query: Query | None = None,
3303
- timeout: float | None = None,
3304
- body: JSONValue = None,
3305
- ) -> _types.VoiceJob:
3306
- """POST /v1/speech — json response."""
3307
- response = self._request(
3308
- "POST", "/v1/speech", path={}, query=query, timeout=timeout, body=body
3309
- )
3310
- return response.json()
3311
-
3312
- def delete_speech_job(
3313
- self, job_id: str, *, query: Query | None = None, timeout: float | None = None
3314
- ) -> _types.Forgotten:
3315
- """DELETE /v1/speech/jobs/:job-id — json response."""
3316
- response = self._request(
3317
- "DELETE",
3318
- "/v1/speech/jobs/:job-id",
3319
- path={"job-id": job_id},
3320
- query=query,
3321
- timeout=timeout,
3322
- )
3323
- return response.json()
3324
-
3325
- def get_speech_job(
3326
- self, job_id: str, *, query: Query | None = None, timeout: float | None = None
3327
- ) -> _types.VoiceJob:
3328
- """GET /v1/speech/jobs/:job-id — json response."""
3329
- response = self._request(
3330
- "GET",
3331
- "/v1/speech/jobs/:job-id",
3332
- path={"job-id": job_id},
3333
- query=query,
3334
- timeout=timeout,
3335
- )
3336
- return response.json()
3337
-
3338
- def get_speech_job_audio(
3339
- self, job_id: str, *, query: Query | None = None, timeout: float | None = None
3340
- ) -> Response:
3341
- """GET /v1/speech/jobs/:job-id/audio — binary response."""
3342
- response = self._request(
3343
- "GET",
3344
- "/v1/speech/jobs/:job-id/audio",
3345
- path={"job-id": job_id},
3346
- query=query,
3347
- timeout=timeout,
3348
- )
3349
- return response
3350
-
3351
- def get_speech_model(
3352
- self, *, query: Query | None = None, timeout: float | None = None
3353
- ) -> _types.VoiceModel:
3354
- """GET /v1/speech/model — json response."""
3355
- response = self._request(
3356
- "GET", "/v1/speech/model", path={}, query=query, timeout=timeout
3357
- )
3358
- return response.json()
3359
-
3360
- def post_speech_model(
3361
- self, *, query: Query | None = None, timeout: float | None = None
3362
- ) -> _types.VoiceModel:
3363
- """POST /v1/speech/model — json response."""
3364
- response = self._request(
3365
- "POST", "/v1/speech/model", path={}, query=query, timeout=timeout
3366
- )
3367
- return response.json()
3368
-
3369
- def get_speech_voices(
3370
- self, *, query: Query | None = None, timeout: float | None = None
3371
- ) -> _types.SpeechVoices:
3372
- """GET /v1/speech/voices — json response."""
3373
- response = self._request(
3374
- "GET", "/v1/speech/voices", path={}, query=query, timeout=timeout
3375
- )
3376
- return response.json()
3377
-
3378
- def post_speech_voices(
3379
- self,
3380
- *,
3381
- query: Query | None = None,
3382
- timeout: float | None = None,
3383
- content: bytes | None,
3384
- ) -> _types.SpeechVoice:
3385
- """POST /v1/speech/voices — json response."""
3386
- response = self._request(
3387
- "POST",
3388
- "/v1/speech/voices",
3389
- path={},
3390
- query=query,
3391
- timeout=timeout,
3392
- content=content,
3393
- )
3394
- return response.json()
3395
-
3396
- def delete_speech_voice(
3397
- self, voice_id: str, *, query: Query | None = None, timeout: float | None = None
3398
- ) -> _types.Forgotten:
3399
- """DELETE /v1/speech/voices/:voice-id — json response."""
3400
- response = self._request(
3401
- "DELETE",
3402
- "/v1/speech/voices/:voice-id",
3403
- path={"voice-id": voice_id},
3404
- query=query,
3405
- timeout=timeout,
3406
- )
3407
- return response.json()
3408
-
3409
- def patch_speech_voice(
3410
- self,
3411
- voice_id: str,
3412
- *,
3413
- query: Query | None = None,
3414
- timeout: float | None = None,
3415
- body: JSONValue = None,
3416
- ) -> _types.SpeechVoice:
3417
- """PATCH /v1/speech/voices/:voice-id — json response."""
3418
- response = self._request(
3419
- "PATCH",
3420
- "/v1/speech/voices/:voice-id",
3421
- path={"voice-id": voice_id},
3422
- query=query,
3423
- timeout=timeout,
3424
- body=body,
3425
- )
3426
- return response.json()
3427
-
3428
- def get_speech_voice_sample(
3429
- self, voice_id: str, *, query: Query | None = None, timeout: float | None = None
3430
- ) -> Response:
3431
- """GET /v1/speech/voices/:voice-id/sample — binary response."""
3432
- response = self._request(
3433
- "GET",
3434
- "/v1/speech/voices/:voice-id/sample",
3435
- path={"voice-id": voice_id},
3436
- query=query,
3437
- timeout=timeout,
3438
- )
3439
- return response
3440
-
3441
- def get_decision_models(
3442
- self, *, timeout: float | None = None
3443
- ) -> _types.DecisionModels:
3444
- """GET /v1/decisions/models — installed and resident decision versions."""
3445
- response = self._request(
3446
- "GET", "/v1/decisions/models", path={}, timeout=timeout
3447
- )
3448
- return response.json()
3449
-
3450
- def get_decision_model(
3451
- self, model_ref: str, *, timeout: float | None = None
3452
- ) -> _types.DecisionModel:
3453
- """GET /v1/decisions/models/:model-ref — immutable status after upload."""
3454
- return self._request(
3455
- "GET",
3456
- "/v1/decisions/models/:model-ref",
3457
- path={"model-ref": model_ref},
3458
- timeout=timeout,
3459
- ).json()
3460
-
3461
- def get_decision_alias(
3462
- self, alias: str, *, timeout: float | None = None
3463
- ) -> _types.DecisionAlias:
3464
- """GET /v1/decisions/aliases/:alias — current ref before a CAS update."""
3465
- return self._request(
3466
- "GET",
3467
- "/v1/decisions/aliases/:alias",
3468
- path={"alias": alias},
3469
- timeout=timeout,
3470
- ).json()
3471
-
3472
- def put_decision_alias(
3473
- self,
3474
- alias: str,
3475
- *,
3476
- model_ref: str,
3477
- expected_current: str | None = None,
3478
- timeout: float | None = None,
3479
- ) -> _types.DecisionAlias:
3480
- """PUT /v1/decisions/aliases/:alias — explicit compare-and-swap update."""
3481
- return self._request(
3482
- "PUT",
3483
- "/v1/decisions/aliases/:alias",
3484
- path={"alias": alias},
3485
- body={"model_ref": model_ref, "expected_current": expected_current},
3486
- timeout=timeout,
3487
- ).json()
3488
-
3489
- def post_decision_training_job(
3490
- self, *, body: JSONValue, timeout: float | None = None
3491
- ) -> _types.DecisionJob:
3492
- """POST /v1/decisions/training/jobs — train on approved local data."""
3493
- return self._request(
3494
- "POST", "/v1/decisions/training/jobs", path={}, body=body, timeout=timeout
3495
- ).json()
3496
-
3497
- def get_decision_training_job(
3498
- self, job_id: str, *, timeout: float | None = None
3499
- ) -> _types.DecisionJob:
3500
- """GET /v1/decisions/training/jobs/:job-id — durable progress."""
3501
- return self._request(
3502
- "GET",
3503
- "/v1/decisions/training/jobs/:job-id",
3504
- path={"job-id": job_id},
3505
- timeout=timeout,
3506
- ).json()
3507
-
3508
- def delete_decision_training_job(
3509
- self, job_id: str, *, timeout: float | None = None
3510
- ) -> _types.DecisionJob:
3511
- """DELETE /v1/decisions/training/jobs/:job-id — cancel or discard."""
3512
- return self._request(
3513
- "DELETE",
3514
- "/v1/decisions/training/jobs/:job-id",
3515
- path={"job-id": job_id},
3516
- timeout=timeout,
3517
- ).json()
3518
-
3519
- def post_systemone(
3520
- self, *, body: JSONValue, timeout: float | None = None
3521
- ) -> _types.DecisionAnswer:
3522
- """POST /v1/systemone — typed decisions from an explicitly named model."""
3523
- response = self._request(
3524
- "POST", "/v1/systemone", path={}, timeout=timeout, body=body
3525
- )
3526
- return response.json()
3527
-
3528
- def post_voice(
3529
- self,
3530
- *,
3531
- query: Query | None = None,
3532
- timeout: float | None = None,
3533
- content: bytes | None,
3534
- ) -> _types.VoiceJob:
3535
- """POST /v1/voice — json response."""
3536
- response = self._request(
3537
- "POST", "/v1/voice", path={}, query=query, timeout=timeout, content=content
3538
- )
3539
- return response.json()
3540
-
3541
- def delete_voice_job(
3542
- self, job_id: str, *, query: Query | None = None, timeout: float | None = None
3543
- ) -> _types.Forgotten:
3544
- """DELETE /v1/voice/jobs/:job-id — json response."""
3545
- response = self._request(
3546
- "DELETE",
3547
- "/v1/voice/jobs/:job-id",
3548
- path={"job-id": job_id},
3549
- query=query,
3550
- timeout=timeout,
3551
- )
3552
- return response.json()
3553
-
3554
- def get_voice_job(
3555
- self, job_id: str, *, query: Query | None = None, timeout: float | None = None
3556
- ) -> _types.VoiceJob:
3557
- """GET /v1/voice/jobs/:job-id — json response."""
3558
- response = self._request(
3559
- "GET",
3560
- "/v1/voice/jobs/:job-id",
3561
- path={"job-id": job_id},
3562
- query=query,
3563
- timeout=timeout,
3564
- )
3565
- return response.json()
3566
-
3567
- def get_voice_model(
3568
- self, *, query: Query | None = None, timeout: float | None = None
3569
- ) -> _types.VoiceModel:
3570
- """GET /v1/voice/model — json response."""
3571
- response = self._request(
3572
- "GET", "/v1/voice/model", path={}, query=query, timeout=timeout
3573
- )
3574
- return response.json()
3575
-
3576
- def post_voice_model(
3577
- self, *, query: Query | None = None, timeout: float | None = None
3578
- ) -> _types.VoiceModel:
3579
- """POST /v1/voice/model — json response."""
3580
- response = self._request(
3581
- "POST", "/v1/voice/model", path={}, query=query, timeout=timeout
3582
- )
3583
- return response.json()
3584
-
3585
1070
  def _job_events(self, route, job_id, event_name, snapshot, **options):
3586
1071
  return JobEvents(self, route, job_id, event_name, **options)
3587
1072
 
@@ -3591,7 +1076,7 @@ class ExecutionLayer(ABC):
3591
1076
  self._job_route("speech", job_id),
3592
1077
  job_id,
3593
1078
  _JOB_EVENTS["synthesize"],
3594
- lambda: self.get_speech_job(job_id),
1079
+ lambda: self.routes.get_speech_job(job_id),
3595
1080
  **options,
3596
1081
  )
3597
1082
 
@@ -3601,7 +1086,7 @@ class ExecutionLayer(ABC):
3601
1086
  self._job_route("voice", job_id),
3602
1087
  job_id,
3603
1088
  _JOB_EVENTS["transcribe"],
3604
- lambda: self.get_voice_job(job_id),
1089
+ lambda: self.routes.get_voice_job(job_id),
3605
1090
  **options,
3606
1091
  )
3607
1092
 
@@ -3611,7 +1096,7 @@ class ExecutionLayer(ABC):
3611
1096
  self._job_route("speech", job_id, sid),
3612
1097
  job_id,
3613
1098
  _JOB_EVENTS["synthesize"],
3614
- lambda: self.get_session_speech_job(sid, job_id),
1099
+ lambda: self.routes.get_session_speech_job(sid, job_id),
3615
1100
  **options,
3616
1101
  )
3617
1102
 
@@ -3621,7 +1106,7 @@ class ExecutionLayer(ABC):
3621
1106
  self._job_route("voice", job_id, sid),
3622
1107
  job_id,
3623
1108
  _JOB_EVENTS["transcribe"],
3624
- lambda: self.get_session_voice_job(sid, job_id),
1109
+ lambda: self.routes.get_session_voice_job(sid, job_id),
3625
1110
  **options,
3626
1111
  )
3627
1112
 
@@ -3652,10 +1137,10 @@ class _UploadStream:
3652
1137
  return chunk
3653
1138
 
3654
1139
 
3655
- class GatewayClient(ExecutionLayer):
1140
+ class GatewayClient(EngineClient):
3656
1141
  """Use an existing Vis gateway through an explicit HTTP(S) origin.
3657
1142
 
3658
- Choose this layer when sessions must outlive your Python process, or when
1143
+ Choose this client when sessions must outlive your Python process, or when
3659
1144
  the engine runs on another machine. It never starts or discovers a gateway,
3660
1145
  and it never reads locally saved credentials. Get an authorized gateway URL
3661
1146
  and token separately. Keep tokens out of source code and logs.
@@ -3669,7 +1154,7 @@ class GatewayClient(ExecutionLayer):
3669
1154
  Construction makes no network request. Context entry calls `connect` to
3670
1155
  check protocol compatibility and acquire a client lease. Closing releases
3671
1156
  this client's lease and streams, not the gateway or its stored sessions.
3672
- Reuse the same layer for multiple agents, then close it after those agents.
1157
+ Reuse the same client for multiple agents, then close it after those agents.
3673
1158
 
3674
1159
  ```python
3675
1160
  import os
@@ -3961,11 +1446,11 @@ class GatewayClient(ExecutionLayer):
3961
1446
 
3962
1447
  @dataclass(frozen=True, slots=True)
3963
1448
  class Session:
3964
- """A conversation handle bound to one execution layer and session ID.
1449
+ """A conversation handle bound to one client and session ID.
3965
1450
 
3966
- Get it from `Agent.session`, `ExecutionLayer.create_session` or
3967
- `ExecutionLayer.session`. Constructing a handle does not read the session.
3968
- The handle borrows the layer. Keep the layer open while you use the handle.
1451
+ Get it from `Agent.session`, `EngineClient.create_session` or
1452
+ `EngineClient.session`. Constructing a handle does not read the session.
1453
+ The handle borrows the client. Keep the client open while you use the handle.
3969
1454
 
3970
1455
  Use `send` for a new turn and `turns` for history. `read` fetches the
3971
1456
  current session state. `events` follows progress. `input_views` and `answer`
@@ -3979,7 +1464,7 @@ class Session:
3979
1464
  mutations.
3980
1465
  """
3981
1466
 
3982
- client: ExecutionLayer
1467
+ client: EngineClient
3983
1468
  id: str
3984
1469
 
3985
1470
  def _call(self, method, suffix="", **kwargs) -> Any:
@@ -4011,7 +1496,7 @@ class Session:
4011
1496
  validate("council", "binding", binding)
4012
1497
  return Council(self, binding["default_group_id"], binding["activation_id"])
4013
1498
 
4014
- def read(self) -> _types.Session:
1499
+ def read(self) -> _types.SessionRecord:
4015
1500
  """Fetch the current session record as a dictionary.
4016
1501
 
4017
1502
  Pending application-owned tool calls are serviced on the calling thread
@@ -4020,7 +1505,7 @@ class Session:
4020
1505
  self.client._pump_client_extensions(self.id)
4021
1506
  return self._call("GET")
4022
1507
 
4023
- def update(self, **fields: object) -> _types.Session:
1508
+ def update(self, **fields: object) -> _types.SessionRecord:
4024
1509
  """Patch session fields and return the engine's JSON response.
4025
1510
 
4026
1511
  Field names and validation follow the gateway session-update contract.
@@ -4028,7 +1513,7 @@ class Session:
4028
1513
  """
4029
1514
  return self._call("PATCH", body=fields)
4030
1515
 
4031
- def set_group(self, group: SessionGroup | str | None) -> _types.Session:
1516
+ def set_group(self, group: SessionGroup | str | None) -> _types.SessionRecord:
4032
1517
  """Put this session in a group and return the session record.
4033
1518
 
4034
1519
  The session moves to the project of the group. With None, the session
@@ -4046,7 +1531,9 @@ class Session:
4046
1531
  """
4047
1532
  return self._call("DELETE")
4048
1533
 
4049
- def turns(self, **query: str | int | float | bool | None) -> list[_types.Turn]:
1534
+ def turns(
1535
+ self, **query: str | int | float | bool | None
1536
+ ) -> list[_types.TurnRecord]:
4050
1537
  """Read turn history, or the queued subset with status='queued'."""
4051
1538
  return _field(self._call("GET", "/turns", query=query), "turns", list)
4052
1539
 
@@ -4212,7 +1699,7 @@ class Session:
4212
1699
  timeout: float = 300,
4213
1700
  response_model: None = None,
4214
1701
  **options,
4215
- ) -> _types.Turn: ...
1702
+ ) -> _types.TurnRecord: ...
4216
1703
 
4217
1704
  @overload
4218
1705
  def run(
@@ -4233,7 +1720,7 @@ class Session:
4233
1720
  response_model: type[ResponseModel] | None = None,
4234
1721
  max_corrections: int = 2,
4235
1722
  **options,
4236
- ) -> _types.Turn | ResponseModel:
1723
+ ) -> _types.TurnRecord | ResponseModel:
4237
1724
  """Submit a request and wait for its result, as `Agent.run` does.
4238
1725
 
4239
1726
  Without `response_model`, return the turn dictionary in contract form.
@@ -4259,7 +1746,7 @@ class Session:
4259
1746
  def set_model(self, provider: str | None, model: str | None) -> SessionModel:
4260
1747
  """Pin the provider and model of the next turns, or clear the pin with None.
4261
1748
 
4262
- Get the names from `ExecutionLayer.models`. The gateway refuses a provider
1749
+ Get the names from `EngineClient.models`. The gateway refuses a provider
4263
1750
  that it does not serve. A running or queued turn keeps its model. A model
4264
1751
  request can cost money; `Model.pricing` gives the rates.
4265
1752
  """
@@ -4283,12 +1770,12 @@ class Session:
4283
1770
  """Return a snapshot of this session and its managed children as bytes.
4284
1771
 
4285
1772
  Save the bytes as a `.vissnap` file, and restore them with
4286
- `ExecutionLayer.restore_session`. The snapshot holds turns, attachments
1773
+ `EngineClient.restore_session`. The snapshot holds turns, attachments
4287
1774
  and the Council entries inside the session tree. It does not hold
4288
1775
  provider credentials or workspace files. The `session_snapshot_limit`
4289
1776
  setting limits its size.
4290
1777
  """
4291
- return self.client.get_session_snapshot(self.id).content
1778
+ return self.client.routes.get_session_snapshot(self.id).content
4292
1779
 
4293
1780
  def input_views(self) -> list[InputView]:
4294
1781
  """Read pending input requests as typed `blockether.vis.views.InputView` records.
@@ -4459,15 +1946,15 @@ class Turn:
4459
1946
 
4460
1947
  Returned by `Agent.send` or `Session.send`. `id` identifies this request.
4461
1948
  `cursor` is the session event position captured before submission. The
4462
- handle borrows its session and execution layer. Keep that layer open while
4463
- you call `read`, `wait` or `cancel`.
1949
+ handle borrows its session and client. Keep that client open while you call
1950
+ `read`, `wait` or `cancel`.
4464
1951
  """
4465
1952
 
4466
1953
  session: Session
4467
1954
  id: str
4468
1955
  cursor: int = 0
4469
1956
 
4470
- def read(self, *, timeout=None) -> _types.Turn:
1957
+ def read(self, *, timeout=None) -> _types.TurnRecord:
4471
1958
  """Fetch this turn's current record, including its `status`.
4472
1959
 
4473
1960
  `timeout` optionally overrides this request's transport deadline in
@@ -4494,7 +1981,7 @@ class Turn:
4494
1981
  """
4495
1982
  return self.session.attachments(self)
4496
1983
 
4497
- def wait(self, *, timeout: float = 300) -> _types.Turn:
1984
+ def wait(self, *, timeout: float = 300) -> _types.TurnRecord:
4498
1985
  """Wait until this turn finishes or suspends, returning its record.
4499
1986
 
4500
1987
  Args:
@@ -4572,7 +2059,7 @@ class Attachment:
4572
2059
  is the position of the file in the iteration `iteration_id`, the address
4573
2060
  that `Session.download_attachment` takes. `version` counts from 1 and grows
4574
2061
  each time the agent attaches the same `filename` again. The record borrows
4575
- its session and execution layer. Keep that layer open while you read.
2062
+ its session and client. Keep that client open while you read.
4576
2063
  """
4577
2064
 
4578
2065
  session: Session
@@ -5021,7 +2508,7 @@ class _SessionPollingEvents(_PollingEvents["StreamEvent"], Events):
5021
2508
  self.client._pump_client_extensions(self.session.id)
5022
2509
 
5023
2510
  def _page(self):
5024
- data = self.client.get_session_events_since(
2511
+ data = self.client.routes.get_session_events_since(
5025
2512
  self.session.id, query={"cursor": self.cursor, "replay": "full"}
5026
2513
  )
5027
2514
  if not isinstance(data, dict) or not isinstance(data.get("events"), list):