36 36
37 The error type.37 The error type.
38 38
3939 - `status: "pending" or "ready" or "connected" or 2 more` - `status: "pending" or "ready" or "connected" or 4 more`
40 40
41 The environment's connection status.41 The environment's connection status.
42 42
56 56
57 The environment is disconnected.57 The environment is disconnected.
58 58
59 - `"suspended"`
60
61 The environment is stopped and can be resumed from its private checkpoint.
62
63 - `"expired"`
64
65 The environment and its private checkpoint have expired.
66
59 - `"failed"`67 - `"failed"`
60 68
61 The environment failed to connect.69 The environment failed to connect.
103}111}
104```112```
105 113
114<a id="agent.session.environment.suspended"></a>
115
116## agent.session.environment.suspended
117
118Emitted after an idle hosted session environment is checkpointed and stopped.
119
120### Schema
121
122Schema name: `SessionEventAgentSessionEnvironmentSuspended`
123
124- `environment: AgentSessionEnvironmentState`
125
126 The current environment state.
127
128 - `id: string`
129
130 The public ID of the environment.
131
132 - `error: object { code, message, type } or null`
133
134 The error reported while preparing the environment, if any.
135
136 - `code: string`
137
138 A machine-readable error code.
139
140 - `message: string`
141
142 A human-readable error message.
143
144 - `type: string`
145
146 The error type.
147
148 - `status: "pending" or "ready" or "connected" or 4 more`
149
150 The environment's connection status.
151
152 - `"pending"`
153
154 The environment is being prepared.
155
156 - `"ready"`
157
158 The environment is ready to connect.
159
160 - `"connected"`
161
162 The environment is connected.
163
164 - `"disconnected"`
165
166 The environment is disconnected.
167
168 - `"suspended"`
169
170 The environment is stopped and can be resumed from its private checkpoint.
171
172 - `"expired"`
173
174 The environment and its private checkpoint have expired.
175
176 - `"failed"`
177
178 The environment failed to connect.
179
180 - `type: string`
181
182 The environment type.
183
184- `event_id: string`
185
186 The unique ID of the event.
187
188- `session_id: string`
189
190 The ID of the session associated with the event.
191
192- `turn_id: string or null`
193
194 The ID of the turn associated with the event, when applicable.
195
196- `type: "agent.session.environment.suspended"`
197
198 The type of the object. Always `agent.session.environment.suspended`.
199
200 - `"agent.session.environment.suspended"`
201
202### Example
203
204```json
205{
206 "type": "agent.session.environment.suspended",
207 "event_id": "event_id",
208 "session_id": "session_id",
209 "turn_id": "turn_id",
210 "environment": {
211 "id": "id",
212 "type": "type",
213 "status": "pending",
214 "error": {
215 "type": "type",
216 "code": "code",
217 "message": "message"
218 }
219 }
220}
221```
222
223<a id="agent.session.environment.expired"></a>
224
225## agent.session.environment.expired
226
227Emitted after a suspended hosted session environment and its checkpoint expire.
228
229### Schema
230
231Schema name: `SessionEventAgentSessionEnvironmentExpired`
232
233- `environment: AgentSessionEnvironmentState`
234
235 The current environment state.
236
237 - `id: string`
238
239 The public ID of the environment.
240
241 - `error: object { code, message, type } or null`
242
243 The error reported while preparing the environment, if any.
244
245 - `code: string`
246
247 A machine-readable error code.
248
249 - `message: string`
250
251 A human-readable error message.
252
253 - `type: string`
254
255 The error type.
256
257 - `status: "pending" or "ready" or "connected" or 4 more`
258
259 The environment's connection status.
260
261 - `"pending"`
262
263 The environment is being prepared.
264
265 - `"ready"`
266
267 The environment is ready to connect.
268
269 - `"connected"`
270
271 The environment is connected.
272
273 - `"disconnected"`
274
275 The environment is disconnected.
276
277 - `"suspended"`
278
279 The environment is stopped and can be resumed from its private checkpoint.
280
281 - `"expired"`
282
283 The environment and its private checkpoint have expired.
284
285 - `"failed"`
286
287 The environment failed to connect.
288
289 - `type: string`
290
291 The environment type.
292
293- `event_id: string`
294
295 The unique ID of the event.
296
297- `session_id: string`
298
299 The ID of the session associated with the event.
300
301- `turn_id: string or null`
302
303 The ID of the turn associated with the event, when applicable.
304
305- `type: "agent.session.environment.expired"`
306
307 The type of the object. Always `agent.session.environment.expired`.
308
309 - `"agent.session.environment.expired"`
310
311### Example
312
313```json
314{
315 "type": "agent.session.environment.expired",
316 "event_id": "event_id",
317 "session_id": "session_id",
318 "turn_id": "turn_id",
319 "environment": {
320 "id": "id",
321 "type": "type",
322 "status": "pending",
323 "error": {
324 "type": "type",
325 "code": "code",
326 "message": "message"
327 }
328 }
329}
330```
331
106<a id="agent.session.environment.reset"></a>332<a id="agent.session.environment.reset"></a>
107 333
108## agent.session.environment.reset334## agent.session.environment.reset
7112 7338
7113 The error type.7339 The error type.
7114 7340
71157341 - `status: "pending" or "ready" or "connected" or 2 more` - `status: "pending" or "ready" or "connected" or 4 more`
7116 7342
7117 The environment's connection status.7343 The environment's connection status.
7118 7344
7132 7358
7133 The environment is disconnected.7359 The environment is disconnected.
7134 7360
7361 - `"suspended"`
7362
7363 The environment is stopped and can be resumed from its private checkpoint.
7364
7365 - `"expired"`
7366
7367 The environment and its private checkpoint have expired.
7368
7135 - `"failed"`7369 - `"failed"`
7136 7370
7137 The environment failed to connect.7371 The environment failed to connect.
7213 7447
7214 The error type.7448 The error type.
7215 7449
72167450 - `status: "pending" or "ready" or "connected" or 2 more` - `status: "pending" or "ready" or "connected" or 4 more`
7217 7451
7218 The environment's connection status.7452 The environment's connection status.
7219 7453
7233 7467
7234 The environment is disconnected.7468 The environment is disconnected.
7235 7469
7470 - `"suspended"`
7471
7472 The environment is stopped and can be resumed from its private checkpoint.
7473
7474 - `"expired"`
7475
7476 The environment and its private checkpoint have expired.
7477
7236 - `"failed"`7478 - `"failed"`
7237 7479
7238 The environment failed to connect.7480 The environment failed to connect.
7314 7556
7315 The error type.7557 The error type.
7316 7558
73177559 - `status: "pending" or "ready" or "connected" or 2 more` - `status: "pending" or "ready" or "connected" or 4 more`
7318 7560
7319 The environment's connection status.7561 The environment's connection status.
7320 7562
7334 7576
7335 The environment is disconnected.7577 The environment is disconnected.
7336 7578
7579 - `"suspended"`
7580
7581 The environment is stopped and can be resumed from its private checkpoint.
7582
7583 - `"expired"`
7584
7585 The environment and its private checkpoint have expired.
7586
7337 - `"failed"`7587 - `"failed"`
7338 7588
7339 The environment failed to connect.7589 The environment failed to connect.
7415 7665
7416 The error type.7666 The error type.
7417 7667
74187668 - `status: "pending" or "ready" or "connected" or 2 more` - `status: "pending" or "ready" or "connected" or 4 more`
7419 7669
7420 The environment's connection status.7670 The environment's connection status.
7421 7671
7435 7685
7436 The environment is disconnected.7686 The environment is disconnected.
7437 7687
7688 - `"suspended"`
7689
7690 The environment is stopped and can be resumed from its private checkpoint.
7691
7692 - `"expired"`
7693
7694 The environment and its private checkpoint have expired.
7695
7438 - `"failed"`7696 - `"failed"`
7439 7697
7440 The environment failed to connect.7698 The environment failed to connect.