22 22
23 - `error: object { code, message, type } or null`23 - `error: object { code, message, type } or null`
24 24
2525 An error reported while preparing a session environment. The error reported while preparing the environment, if any.
26 26
27 - `code: string`27 - `code: string`
28 28
103}103}
104```104```
105 105
106<a id="agent.session.environment.reset"></a>
107
108## agent.session.environment.reset
109
110Emitted after a hosted sandbox is replaced. Conversation history survives; changes to the previous sandbox's files and processes do not.
111
112### Schema
113
114Schema name: `SessionEventAgentSessionEnvironmentReset`
115
116- `environment_id: string`
117
118 The stable environment ID, retained across sandbox replacements.
119
120- `event_id: string`
121
122 The unique ID of the event.
123
124- `reset_count: number`
125
126 Monotonically increasing reset number. Repeated notifications share this number.
127
128- `session_id: string`
129
130 The ID of the session associated with the event.
131
132- `turn_id: string or null`
133
134 The associated turn, when applicable.
135
136- `type: "agent.session.environment.reset"`
137
138 The type of the object. Always `agent.session.environment.reset`.
139
140 - `"agent.session.environment.reset"`
141
142### Example
143
144```json
145{
146 "type": "agent.session.environment.reset"
147}
148```
149
106<a id="agent.output.command_execution_output.delta"></a>150<a id="agent.output.command_execution_output.delta"></a>
107 151
108## agent.output.command_execution_output.delta152## agent.output.command_execution_output.delta
217 261
218 - `effort: "none" or "minimal" or "low" or 4 more or null`262 - `effort: "none" or "minimal" or "low" or 4 more or null`
219 263
220264 The amount of reasoning effort used by an agent. The requested reasoning effort, or `null` when the model selects its own default.
221 265
222 - `"none"`266 - `"none"`
223 267
235 279
236 - `summary: "concise" or "detailed" or "auto" or null`280 - `summary: "concise" or "detailed" or "auto" or null`
237 281
238282 The reasoning summary format requested from an agent. The requested reasoning summary format, or `null` when summaries are disabled.
239 283
240 - `"concise"`284 - `"concise"`
241 285
451 495
452 - `location: object { city, country, region, timezone } or null`496 - `location: object { city, country, region, timezone } or null`
453 497
454498 Approximate user location used to localize web search results. Approximate location used to localize search results, if provided.
455 499
456 - `city: string or null`500 - `city: string or null`
457 501
789 833
790 - `usage: TokenUsage or null`834 - `usage: TokenUsage or null`
791 835
792836 Recorded token usage for a session or turn. Usage is best effort and may change. Best-effort token usage for the session, or null if unknown. Recorded usage may change.
793 837
794 - `input_tokens: number`838 - `input_tokens: number`
795 839
947 991
948 - `error: SessionTurnError or null`992 - `error: SessionTurnError or null`
949 993
950994 A customer-safe error describing why a session request failed. A customer-safe error. Non-null only for a failed turn.
951 995
952 - `code: "context_length_exceeded" or "session_budget_exceeded" or "usage_limit_exceeded" or 14 more`996 - `code: "context_length_exceeded" or "session_budget_exceeded" or "usage_limit_exceeded" or 14 more`
953 997
1073 1117
1074 - `usage: TokenUsage or null`1118 - `usage: TokenUsage or null`
1075 1119
10761120 Recorded token usage for a session or turn. Usage is best effort and may change. Best-effort token usage for the turn, or null if unknown. Recorded usage may change.
1077 1121
1078 - `input_tokens: number`1122 - `input_tokens: number`
1079 1123
1190 1234
1191 - `error: SessionTurnError or null`1235 - `error: SessionTurnError or null`
1192 1236
11931237 A customer-safe error describing why a session request failed. A customer-safe error. Non-null only for a failed turn.
1194 1238
1195 - `code: "context_length_exceeded" or "session_budget_exceeded" or "usage_limit_exceeded" or 14 more`1239 - `code: "context_length_exceeded" or "session_budget_exceeded" or "usage_limit_exceeded" or 14 more`
1196 1240
1316 1360
1317 - `usage: TokenUsage or null`1361 - `usage: TokenUsage or null`
1318 1362
13191363 Recorded token usage for a session or turn. Usage is best effort and may change. Best-effort token usage for the turn, or null if unknown. Recorded usage may change.
1320 1364
1321 - `input_tokens: number`1365 - `input_tokens: number`
1322 1366
1433 1477
1434 - `error: SessionTurnError or null`1478 - `error: SessionTurnError or null`
1435 1479
14361480 A customer-safe error describing why a session request failed. A customer-safe error. Non-null only for a failed turn.
1437 1481
1438 - `code: "context_length_exceeded" or "session_budget_exceeded" or "usage_limit_exceeded" or 14 more`1482 - `code: "context_length_exceeded" or "session_budget_exceeded" or "usage_limit_exceeded" or 14 more`
1439 1483
1559 1603
1560 - `usage: TokenUsage or null`1604 - `usage: TokenUsage or null`
1561 1605
15621606 Recorded token usage for a session or turn. Usage is best effort and may change. Best-effort token usage for the turn, or null if unknown. Recorded usage may change.
1563 1607
1564 - `input_tokens: number`1608 - `input_tokens: number`
1565 1609
1601 1645
1602- `usage: TokenUsage or null`1646- `usage: TokenUsage or null`
1603 1647
16041648 Recorded token usage for a session or turn. Usage is best effort and may change. Token usage by the root agent during the turn, when available.
1605 1649
1606### Example1650### Example
1607 1651
1691 1735
1692 - `error: SessionTurnError or null`1736 - `error: SessionTurnError or null`
1693 1737
16941738 A customer-safe error describing why a session request failed. A customer-safe error. Non-null only for a failed turn.
1695 1739
1696 - `code: "context_length_exceeded" or "session_budget_exceeded" or "usage_limit_exceeded" or 14 more`1740 - `code: "context_length_exceeded" or "session_budget_exceeded" or "usage_limit_exceeded" or 14 more`
1697 1741
1817 1861
1818 - `usage: TokenUsage or null`1862 - `usage: TokenUsage or null`
1819 1863
18201864 Recorded token usage for a session or turn. Usage is best effort and may change. Best-effort token usage for the turn, or null if unknown. Recorded usage may change.
1821 1865
1822 - `input_tokens: number`1866 - `input_tokens: number`
1823 1867
1859 1903
1860- `usage: TokenUsage or null`1904- `usage: TokenUsage or null`
1861 1905
18621906 Recorded token usage for a session or turn. Usage is best effort and may change. Token usage by the root agent during the turn, when available.
1863 1907
1864### Example1908### Example
1865 1909
1949 1993
1950 - `error: SessionTurnError or null`1994 - `error: SessionTurnError or null`
1951 1995
19521996 A customer-safe error describing why a session request failed. A customer-safe error. Non-null only for a failed turn.
1953 1997
1954 - `code: "context_length_exceeded" or "session_budget_exceeded" or "usage_limit_exceeded" or 14 more`1998 - `code: "context_length_exceeded" or "session_budget_exceeded" or "usage_limit_exceeded" or 14 more`
1955 1999
2075 2119
2076 - `usage: TokenUsage or null`2120 - `usage: TokenUsage or null`
2077 2121
20782122 Recorded token usage for a session or turn. Usage is best effort and may change. Best-effort token usage for the turn, or null if unknown. Recorded usage may change.
2079 2123
2080 - `input_tokens: number`2124 - `input_tokens: number`
2081 2125
2117 2161
2118- `usage: TokenUsage or null`2162- `usage: TokenUsage or null`
2119 2163
21202164 Recorded token usage for a session or turn. Usage is best effort and may change. Token usage by the root agent during the turn, when available.
2121 2165
2122### Example2166### Example
2123 2167
2241 2285
2242 - `phase: "commentary" or "final_answer" or null`2286 - `phase: "commentary" or "final_answer" or null`
2243 2287
22442288 The phase of an assistant message. The phase of an assistant message. Null for user messages.
2245 2289
2246 - `"commentary"`2290 - `"commentary"`
2247 2291
2295 2339
2296 - `status: AgentOutputItemStatus or null`2340 - `status: AgentOutputItemStatus or null`
2297 2341
22982342 The status of an agent output item. The status of the reasoning item.
2299 2343
2300 - `summary: array of SummaryText`2344 - `summary: array of SummaryText`
2301 2345
2389 2433
2390 - `output: AgentFunctionCallOutput or null`2434 - `output: AgentFunctionCallOutput or null`
2391 2435
23922436 The text or model-input content supplied as a function result. The function result, if the call succeeded.
2393 2437
2394 - `string`2438 - `string`
2395 2439
2547 2591
2548 - `action: WebSearchAction or null`2592 - `action: WebSearchAction or null`
2549 2593
25502594 An action performed by the web search tool. The action performed by the web search tool.
2551 2595
2552 - `Search object { queries, query, type }`2596 - `Search object { queries, query, type }`
2553 2597
2989 3033
2990 - `effort: "none" or "minimal" or "low" or 4 more or null`3034 - `effort: "none" or "minimal" or "low" or 4 more or null`
2991 3035
29923036 The amount of reasoning effort used by an agent. The requested reasoning effort, or `null` when the model selects its own default.
2993 3037
2994 - `"none"`3038 - `"none"`
2995 3039
3007 3051
3008 - `summary: "concise" or "detailed" or "auto" or null`3052 - `summary: "concise" or "detailed" or "auto" or null`
3009 3053
30103054 The reasoning summary format requested from an agent. The requested reasoning summary format, or `null` when summaries are disabled.
3011 3055
3012 - `"concise"`3056 - `"concise"`
3013 3057
3223 3267
3224 - `location: object { city, country, region, timezone } or null`3268 - `location: object { city, country, region, timezone } or null`
3225 3269
32263270 Approximate user location used to localize web search results. Approximate location used to localize search results, if provided.
3227 3271
3228 - `city: string or null`3272 - `city: string or null`
3229 3273
3561 3605
3562 - `usage: TokenUsage or null`3606 - `usage: TokenUsage or null`
3563 3607
35643608 Recorded token usage for a session or turn. Usage is best effort and may change. Best-effort token usage for the session, or null if unknown. Recorded usage may change.
3565 3609
3566 - `input_tokens: number`3610 - `input_tokens: number`
3567 3611
3739 3783
3740 - `effort: "none" or "minimal" or "low" or 4 more or null`3784 - `effort: "none" or "minimal" or "low" or 4 more or null`
3741 3785
37423786 The amount of reasoning effort used by an agent. The requested reasoning effort, or `null` when the model selects its own default.
3743 3787
3744 - `"none"`3788 - `"none"`
3745 3789
3757 3801
3758 - `summary: "concise" or "detailed" or "auto" or null`3802 - `summary: "concise" or "detailed" or "auto" or null`
3759 3803
37603804 The reasoning summary format requested from an agent. The requested reasoning summary format, or `null` when summaries are disabled.
3761 3805
3762 - `"concise"`3806 - `"concise"`
3763 3807
3973 4017
3974 - `location: object { city, country, region, timezone } or null`4018 - `location: object { city, country, region, timezone } or null`
3975 4019
39764020 Approximate user location used to localize web search results. Approximate location used to localize search results, if provided.
3977 4021
3978 - `city: string or null`4022 - `city: string or null`
3979 4023
4311 4355
4312 - `usage: TokenUsage or null`4356 - `usage: TokenUsage or null`
4313 4357
43144358 Recorded token usage for a session or turn. Usage is best effort and may change. Best-effort token usage for the session, or null if unknown. Recorded usage may change.
4315 4359
4316 - `input_tokens: number`4360 - `input_tokens: number`
4317 4361
4489 4533
4490 - `effort: "none" or "minimal" or "low" or 4 more or null`4534 - `effort: "none" or "minimal" or "low" or 4 more or null`
4491 4535
44924536 The amount of reasoning effort used by an agent. The requested reasoning effort, or `null` when the model selects its own default.
4493 4537
4494 - `"none"`4538 - `"none"`
4495 4539
4507 4551
4508 - `summary: "concise" or "detailed" or "auto" or null`4552 - `summary: "concise" or "detailed" or "auto" or null`
4509 4553
45104554 The reasoning summary format requested from an agent. The requested reasoning summary format, or `null` when summaries are disabled.
4511 4555
4512 - `"concise"`4556 - `"concise"`
4513 4557
4723 4767
4724 - `location: object { city, country, region, timezone } or null`4768 - `location: object { city, country, region, timezone } or null`
4725 4769
47264770 Approximate user location used to localize web search results. Approximate location used to localize search results, if provided.
4727 4771
4728 - `city: string or null`4772 - `city: string or null`
4729 4773
5061 5105
5062 - `usage: TokenUsage or null`5106 - `usage: TokenUsage or null`
5063 5107
50645108 Recorded token usage for a session or turn. Usage is best effort and may change. Best-effort token usage for the session, or null if unknown. Recorded usage may change.
5065 5109
5066 - `input_tokens: number`5110 - `input_tokens: number`
5067 5111
5239 5283
5240 - `effort: "none" or "minimal" or "low" or 4 more or null`5284 - `effort: "none" or "minimal" or "low" or 4 more or null`
5241 5285
52425286 The amount of reasoning effort used by an agent. The requested reasoning effort, or `null` when the model selects its own default.
5243 5287
5244 - `"none"`5288 - `"none"`
5245 5289
5257 5301
5258 - `summary: "concise" or "detailed" or "auto" or null`5302 - `summary: "concise" or "detailed" or "auto" or null`
5259 5303
52605304 The reasoning summary format requested from an agent. The requested reasoning summary format, or `null` when summaries are disabled.
5261 5305
5262 - `"concise"`5306 - `"concise"`
5263 5307
5473 5517
5474 - `location: object { city, country, region, timezone } or null`5518 - `location: object { city, country, region, timezone } or null`
5475 5519
54765520 Approximate user location used to localize web search results. Approximate location used to localize search results, if provided.
5477 5521
5478 - `city: string or null`5522 - `city: string or null`
5479 5523
5811 5855
5812 - `usage: TokenUsage or null`5856 - `usage: TokenUsage or null`
5813 5857
58145858 Recorded token usage for a session or turn. Usage is best effort and may change. Best-effort token usage for the session, or null if unknown. Recorded usage may change.
5815 5859
5816 - `input_tokens: number`5860 - `input_tokens: number`
5817 5861
5949 5993
5950 - `error: object { code, message, type } or null`5994 - `error: object { code, message, type } or null`
5951 5995
59525996 An error reported while preparing a session environment. The error reported while preparing the environment, if any.
5953 5997
5954 - `code: string`5998 - `code: string`
5955 5999
6050 6094
6051 - `error: object { code, message, type } or null`6095 - `error: object { code, message, type } or null`
6052 6096
60536097 An error reported while preparing a session environment. The error reported while preparing the environment, if any.
6054 6098
6055 - `code: string`6099 - `code: string`
6056 6100
6151 6195
6152 - `error: object { code, message, type } or null`6196 - `error: object { code, message, type } or null`
6153 6197
61546198 An error reported while preparing a session environment. The error reported while preparing the environment, if any.
6155 6199
6156 - `code: string`6200 - `code: string`
6157 6201
6252 6296
6253 - `error: object { code, message, type } or null`6297 - `error: object { code, message, type } or null`
6254 6298
62556299 An error reported while preparing a session environment. The error reported while preparing the environment, if any.
6256 6300
6257 - `code: string`6301 - `code: string`
6258 6302
6744 6788
6745 - `phase: "commentary" or "final_answer" or null`6789 - `phase: "commentary" or "final_answer" or null`
6746 6790
67476791 The phase of an assistant message. The phase of the assistant message.
6748 6792
6749 - `"commentary"`6793 - `"commentary"`
6750 6794
6796 6840
6797 - `status: AgentOutputItemStatus or null`6841 - `status: AgentOutputItemStatus or null`
6798 6842
67996843 The status of an agent output item. The status of the reasoning item.
6800 6844
6801 - `summary: array of SummaryText`6845 - `summary: array of SummaryText`
6802 6846
6924 6968
6925 - `action: WebSearchAction or null`6969 - `action: WebSearchAction or null`
6926 6970
69276971 An action performed by the web search tool. The action performed by the web search tool.
6928 6972
6929 - `Search object { queries, query, type }`6973 - `Search object { queries, query, type }`
6930 6974