156 156
157 The voice used for speech generated by the Live model.157 The voice used for speech generated by the Live model.
158 158
159 - `voice: optional string or "alloy" or "ash" or "aube" or 29 more or CustomVoice`159 - `voice: optional string or "alloy" or "ash" or "ballad" or 28 more or CustomVoice`
160 160
161 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.161 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.
162 162
163 - `string`163 - `string`
164 164
165 - `"alloy" or "ash" or "aube" or 29 more`165 - `"alloy" or "ash" or "ballad" or 28 more`
166 166
167 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.167 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.
168 168
170 170
171 - `"ash"`171 - `"ash"`
172 172
173 - `"aube"`
174
175 - `"ballad"`173 - `"ballad"`
176 174
177 - `"beacon"`175 - `"beacon"`
368 366
369 - `"high"`367 - `"high"`
370 368
371 - `tool_choice: optional "auto" or "none" or "required" or object { name, type } or object { name, server_label, type }`369 - `tool_choice: optional "auto" or "none" or "required" or map[unknown]`
372 370
373 Controls which tool the Responses backend uses when handling a task delegated by the Live model.371 Controls which tool the Responses backend uses when handling a task delegated by the Live model.
374 372
375 - `LiveToolChoiceEnum = "auto" or "none" or "required"`373 - `LiveToolChoiceEnum = "auto" or "none" or "required"`
376 374
375 Controls which tool the Responses backend uses when handling a task delegated by the Live model.
376
377 - `"auto"`377 - `"auto"`
378 378
379 - `"none"`379 - `"none"`
380 380
381 - `"required"`381 - `"required"`
382 382
383 - `LiveFunctionToolChoiceParam object { name, type }`383 - `map[unknown]`
384
385 - `name: string`
386
387 - `type: "function"`
388
389 - `"function"`
390
391 - `LiveMCPToolChoiceParam object { name, server_label, type }`
392
393 - `name: string`
394
395 - `server_label: string`
396
397 - `type: "mcp"`
398
399 - `"mcp"`
400 384
401 - `tools: optional array of FunctionTool or object { type } or object { type } or 3 more`385 - `tools: optional array of FunctionTool or object { type } or object { type } or 10 more`
402 386
403 Tools available to the Responses backend while it handles tasks delegated by the Live model.387 Tools available to the Responses backend while it handles tasks delegated by the Live model.
404 388
450 434
451 - `"code_interpreter"`435 - `"code_interpreter"`
452 436
453 - `Shell object { environment, type }`437 - `Shell object { type, environment }`
454 438
455 A Responses shell tool with a container_auto or container_reference environment. Local execution and domain secrets are not supported.439 A Responses shell tool. Use a hosted container or return local shell results with response.item.create. Domain secrets are not supported.
456
457 - `environment: map[unknown]`
458 440
459 - `type: "shell"`441 - `type: "shell"`
460 442
461 - `"shell"`443 - `"shell"`
462 444
445 - `environment: optional object { type, file_ids, memory_limit, 2 more } or object { container_id, type } or object { type, skills } or null`
446
447 - `ContainerAuto object { type, file_ids, memory_limit, 2 more }`
448
449 - `type: "container_auto"`
450
451 Automatically creates a container for this request
452
453 - `"container_auto"`
454
455 - `file_ids: optional array of string or null`
456
457 An optional list of uploaded files to make available to your code.
458
459 - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
460
461 The memory limit for the container.
462
463 - `"1g"`
464
465 - `"4g"`
466
467 - `"16g"`
468
469 - `"64g"`
470
471 - `network_policy: optional object { type } or object { allowed_domains, type } or null`
472
473 Network access policy for the container.
474
475 - `Disabled object { type }`
476
477 - `type: "disabled"`
478
479 Disable outbound network access. Always `disabled`.
480
481 - `"disabled"`
482
483 - `Allowlist object { allowed_domains, type }`
484
485 - `allowed_domains: array of string`
486
487 A list of allowed domains when type is `allowlist`.
488
489 - `type: "allowlist"`
490
491 Allow outbound network access only to specified domains. Always `allowlist`.
492
493 - `"allowlist"`
494
495 - `skills: optional array of object { skill_id, type, version } or object { description, name, source, type } or null`
496
497 An optional list of skills referenced by id or inline data.
498
499 - `SkillReference object { skill_id, type, version }`
500
501 - `skill_id: string`
502
503 The ID of the referenced skill.
504
505 - `type: "skill_reference"`
506
507 References a skill created with the /v1/skills endpoint.
508
509 - `"skill_reference"`
510
511 - `version: optional string or null`
512
513 Optional skill version. Use a positive integer or 'latest'. Omit for default.
514
515 - `Inline object { description, name, source, type }`
516
517 - `description: string`
518
519 The description of the skill.
520
521 - `name: string`
522
523 The name of the skill.
524
525 - `source: object { data, media_type, type }`
526
527 Inline skill payload
528
529 - `data: string`
530
531 Base64-encoded skill zip bundle.
532
533 - `media_type: "application/zip"`
534
535 The media type of the inline skill payload. Must be `application/zip`.
536
537 - `"application/zip"`
538
539 - `type: "base64"`
540
541 The type of the inline skill source. Must be `base64`.
542
543 - `"base64"`
544
545 - `type: "inline"`
546
547 Defines an inline skill for this request.
548
549 - `"inline"`
550
551 - `ContainerReference object { container_id, type }`
552
553 - `container_id: string`
554
555 The ID of the referenced container.
556
557 - `type: "container_reference"`
558
559 References a container created with the /v1/containers endpoint
560
561 - `"container_reference"`
562
563 - `Local object { type, skills }`
564
565 - `type: "local"`
566
567 Use a local computer environment.
568
569 - `"local"`
570
571 - `skills: optional array of object { description, name, path } or null`
572
573 An optional list of skills.
574
575 - `description: string`
576
577 The description of the skill.
578
579 - `name: string`
580
581 The name of the skill.
582
583 - `path: string`
584
585 The path to the directory containing the skill.
586
463 - `ImageGeneration object { type }`587 - `ImageGeneration object { type }`
464 588
465 - `type: "image_generation"`589 - `type: "image_generation"`
466 590
467 - `"image_generation"`591 - `"image_generation"`
468 592
593 - `Mcp object { type }`
594
595 - `type: "mcp"`
596
597 - `"mcp"`
598
599 - `Custom object { type }`
600
601 - `type: "custom"`
602
603 - `"custom"`
604
605 - `Namespace object { type }`
606
607 - `type: "namespace"`
608
609 - `"namespace"`
610
611 - `ToolSearch object { type }`
612
613 - `type: "tool_search"`
614
615 - `"tool_search"`
616
617 - `ProgrammaticToolCalling object { type }`
618
619 - `type: "programmatic_tool_calling"`
620
621 - `"programmatic_tool_calling"`
622
623 - `Computer object { type }`
624
625 - `type: "computer"`
626
627 - `"computer"`
628
629 - `ApplyPatch object { type }`
630
631 - `type: "apply_patch"`
632
633 - `"apply_patch"`
634
469 - `type: "responses"`635 - `type: "responses"`
470 636
471 The delegation owner. Always `responses` for tasks handled by the Responses API.637 The delegation owner. Always `responses` for tasks handled by the Responses API.
781 947
782 - `"high"`948 - `"high"`
783 949
784 - `tool_choice: optional "auto" or "none" or "required" or object { name, type } or object { name, server_label, type }`950 - `tool_choice: optional "auto" or "none" or "required" or map[unknown]`
785 951
786 Controls which tool the Responses backend uses when handling a task delegated by the Live model.952 Controls which tool the Responses backend uses when handling a task delegated by the Live model.
787 953
788 - `LiveToolChoiceEnum = "auto" or "none" or "required"`954 - `LiveToolChoiceEnum = "auto" or "none" or "required"`
789 955
956 Controls which tool the Responses backend uses when handling a task delegated by the Live model.
957
790 - `"auto"`958 - `"auto"`
791 959
792 - `"none"`960 - `"none"`
793 961
794 - `"required"`962 - `"required"`
795 963
796 - `LiveFunctionToolChoiceParam object { name, type }`964 - `map[unknown]`
797
798 - `name: string`
799
800 - `type: "function"`
801
802 - `"function"`
803
804 - `LiveMCPToolChoiceParam object { name, server_label, type }`
805
806 - `name: string`
807
808 - `server_label: string`
809 965
810 - `type: "mcp"`966 - `tools: optional array of FunctionTool or object { type } or object { type } or 10 more`
811
812 - `"mcp"`
813
814 - `tools: optional array of FunctionTool or object { type } or object { type } or 3 more`
815 967
816 Tools available to the Responses backend while it handles tasks delegated by the Live model.968 Tools available to the Responses backend while it handles tasks delegated by the Live model.
817 969
863 1015
864 - `"code_interpreter"`1016 - `"code_interpreter"`
865 1017
866 - `Shell object { environment, type }`1018 - `Shell object { type, environment }`
867 1019
868 A Responses shell tool with a container_auto or container_reference environment. Local execution and domain secrets are not supported.1020 A Responses shell tool. Use a hosted container or return local shell results with response.item.create. Domain secrets are not supported.
869
870 - `environment: map[unknown]`
871 1021
872 - `type: "shell"`1022 - `type: "shell"`
873 1023
874 - `"shell"`1024 - `"shell"`
875 1025
876 - `ImageGeneration object { type }`1026 - `environment: optional object { type, file_ids, memory_limit, 2 more } or object { container_id, type } or object { type, skills } or null`
877 1027
878 - `type: "image_generation"`1028 - `ContainerAuto object { type, file_ids, memory_limit, 2 more }`
879 1029
880 - `"image_generation"`1030 - `type: "container_auto"`
881 1031
882- `type: "session.update"`1032 Automatically creates a container for this request
883 1033
884 The Live client event type. Always `session.update`.1034 - `"container_auto"`
885 1035
886 - `"session.update"`1036 - `file_ids: optional array of string or null`
887 1037
888- `event_id: optional string or null`1038 An optional list of uploaded files to make available to your code.
889 1039
890 Optional client identifier for correlating this command with a server event's client_event_id or error.client_event_id.1040 - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
891 1041
892#### Example1042 The memory limit for the container.
893 1043
894```json1044 - `"1g"`
895{
896 "type": "session.update",
897 "event_id": "evt_update_001",
898 "session": {
899 "delegation": {
900 "type": "responses",
901 "responses": {
902 "instructions": "Check restaurant availability. Ask before confirming a booking.",
903 "max_output_tokens": 1024
904 }
905 }
906 }
907}
908```
909 1045
910<a id="session.input_audio.append"></a>1046 - `"4g"`
911 1047
912### session.input_audio.append1048 - `"16g"`
913 1049
914Send audio to a Live session over its primary WebSocket. WebRTC and SIP sessions send audio over their media transport.1050 - `"64g"`
915 1051
916#### Schema1052 - `network_policy: optional object { type } or object { allowed_domains, type } or null`
917 1053
918Schema name: `LiveInputAudioAppendEvent`1054 Network access policy for the container.
919 1055
920- `audio: string`1056 - `Disabled object { type }`
921 1057
922 Base64-encoded raw audio in the startup-selected format, without a WAV or other container header. Primary WebSocket only; media transports use their audio track. Audio appends have no acknowledgment. Reflected sideband server events reuse this event type and audio key, with no timestamps or event_id; their audio is always mono PCM16LE at 24 kHz.1058 - `type: "disabled"`
923 1059
924- `type: "session.input_audio.append"`1060 Disable outbound network access. Always `disabled`.
925 1061
926 The Live client event type. Always `session.input_audio.append`.1062 - `"disabled"`
927 1063
928 - `"session.input_audio.append"`1064 - `Allowlist object { allowed_domains, type }`
929 1065
930- `event_id: optional string or null`1066 - `allowed_domains: array of string`
1067
1068 A list of allowed domains when type is `allowlist`.
1069
1070 - `type: "allowlist"`
1071
1072 Allow outbound network access only to specified domains. Always `allowlist`.
1073
1074 - `"allowlist"`
1075
1076 - `skills: optional array of object { skill_id, type, version } or object { description, name, source, type } or null`
1077
1078 An optional list of skills referenced by id or inline data.
1079
1080 - `SkillReference object { skill_id, type, version }`
1081
1082 - `skill_id: string`
1083
1084 The ID of the referenced skill.
1085
1086 - `type: "skill_reference"`
1087
1088 References a skill created with the /v1/skills endpoint.
1089
1090 - `"skill_reference"`
1091
1092 - `version: optional string or null`
1093
1094 Optional skill version. Use a positive integer or 'latest'. Omit for default.
1095
1096 - `Inline object { description, name, source, type }`
1097
1098 - `description: string`
1099
1100 The description of the skill.
1101
1102 - `name: string`
1103
1104 The name of the skill.
1105
1106 - `source: object { data, media_type, type }`
1107
1108 Inline skill payload
1109
1110 - `data: string`
1111
1112 Base64-encoded skill zip bundle.
1113
1114 - `media_type: "application/zip"`
1115
1116 The media type of the inline skill payload. Must be `application/zip`.
1117
1118 - `"application/zip"`
1119
1120 - `type: "base64"`
1121
1122 The type of the inline skill source. Must be `base64`.
1123
1124 - `"base64"`
1125
1126 - `type: "inline"`
1127
1128 Defines an inline skill for this request.
1129
1130 - `"inline"`
1131
1132 - `ContainerReference object { container_id, type }`
1133
1134 - `container_id: string`
1135
1136 The ID of the referenced container.
1137
1138 - `type: "container_reference"`
1139
1140 References a container created with the /v1/containers endpoint
1141
1142 - `"container_reference"`
1143
1144 - `Local object { type, skills }`
1145
1146 - `type: "local"`
1147
1148 Use a local computer environment.
1149
1150 - `"local"`
1151
1152 - `skills: optional array of object { description, name, path } or null`
1153
1154 An optional list of skills.
1155
1156 - `description: string`
1157
1158 The description of the skill.
1159
1160 - `name: string`
1161
1162 The name of the skill.
1163
1164 - `path: string`
1165
1166 The path to the directory containing the skill.
1167
1168 - `ImageGeneration object { type }`
1169
1170 - `type: "image_generation"`
1171
1172 - `"image_generation"`
1173
1174 - `Mcp object { type }`
1175
1176 - `type: "mcp"`
1177
1178 - `"mcp"`
1179
1180 - `Custom object { type }`
1181
1182 - `type: "custom"`
1183
1184 - `"custom"`
1185
1186 - `Namespace object { type }`
1187
1188 - `type: "namespace"`
1189
1190 - `"namespace"`
1191
1192 - `ToolSearch object { type }`
1193
1194 - `type: "tool_search"`
1195
1196 - `"tool_search"`
1197
1198 - `ProgrammaticToolCalling object { type }`
1199
1200 - `type: "programmatic_tool_calling"`
1201
1202 - `"programmatic_tool_calling"`
1203
1204 - `Computer object { type }`
1205
1206 - `type: "computer"`
1207
1208 - `"computer"`
1209
1210 - `ApplyPatch object { type }`
1211
1212 - `type: "apply_patch"`
1213
1214 - `"apply_patch"`
1215
1216- `type: "session.update"`
1217
1218 The Live client event type. Always `session.update`.
1219
1220 - `"session.update"`
1221
1222- `event_id: optional string or null`
1223
1224 Optional client identifier for correlating this command with a server event's client_event_id or error.client_event_id.
1225
1226#### Example
1227
1228```json
1229{
1230 "type": "session.update",
1231 "event_id": "evt_update_001",
1232 "session": {
1233 "delegation": {
1234 "type": "responses",
1235 "responses": {
1236 "instructions": "Check restaurant availability. Ask before confirming a booking.",
1237 "max_output_tokens": 1024
1238 }
1239 }
1240 }
1241}
1242```
1243
1244<a id="session.input_audio.append"></a>
1245
1246### session.input_audio.append
1247
1248Send audio to a Live session over its primary WebSocket. WebRTC and SIP sessions send audio over their media transport.
1249
1250#### Schema
1251
1252Schema name: `LiveInputAudioAppendEvent`
1253
1254- `audio: string`
1255
1256 Base64-encoded raw audio in the startup-selected format, without a WAV or other container header. Primary WebSocket only; media transports use their audio track. Audio appends have no acknowledgment. Reflected sideband server events reuse this event type and audio key, with no timestamps or event_id; their audio is always mono PCM16LE at 24 kHz.
1257
1258- `type: "session.input_audio.append"`
1259
1260 The Live client event type. Always `session.input_audio.append`.
1261
1262 - `"session.input_audio.append"`
1263
1264- `event_id: optional string or null`
931 1265
932 Optional client identifier for correlating this command with a server event's client_event_id or error.client_event_id.1266 Optional client identifier for correlating this command with a server event's client_event_id or error.client_event_id.
933 1267
3235 3569
3236 - `"grammar"`3570 - `"grammar"`
3237 3571
3238 - `Namespace object { description, name, tools, type }`3572 - `ToolSearchOutputNamespaceTool object { description, name, tools, type }`
3239 3573
3240 Groups function/custom tools under a shared namespace.3574 Groups function/custom tools under a shared namespace.
3241 3575
3249 3583
3250 - `tools: array of object { name, type, allowed_callers, 6 more } or object { name, type, allowed_callers, 4 more }`3584 - `tools: array of object { name, type, allowed_callers, 6 more } or object { name, type, allowed_callers, 4 more }`
3251 3585
3252 The function/custom tools available inside this namespace.3586 The function/custom tools loaded inside this namespace.
3253 3587
3254 - `Function object { name, type, allowed_callers, 6 more }`3588 - `Function object { name, type, allowed_callers, 6 more }`
3255 3589
3256 - `name: string`3590 - `name: string`
3257 3591
3592 The name of the loaded function tool.
3593
3258 - `type: "function"`3594 - `type: "function"`
3259 3595
3260 - `"function"`3596 - `"function"`
5736 6072
5737 The voice used for speech generated by the Live model.6073 The voice used for speech generated by the Live model.
5738 6074
5739 - `voice: optional string or "alloy" or "ash" or "aube" or 29 more or CustomVoice`6075 - `voice: optional string or "alloy" or "ash" or "ballad" or 28 more or CustomVoice`
5740 6076
5741 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.6077 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.
5742 6078
5743 - `string`6079 - `string`
5744 6080
5745 - `"alloy" or "ash" or "aube" or 29 more`6081 - `"alloy" or "ash" or "ballad" or 28 more`
5746 6082
5747 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.6083 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.
5748 6084
5750 6086
5751 - `"ash"`6087 - `"ash"`
5752 6088
5753 - `"aube"`
5754
5755 - `"ballad"`6089 - `"ballad"`
5756 6090
5757 - `"beacon"`6091 - `"beacon"`
5948 6282
5949 - `"high"`6283 - `"high"`
5950 6284
5951 - `tool_choice: optional "auto" or "none" or "required" or object { name, type } or object { name, server_label, type }`6285 - `tool_choice: optional "auto" or "none" or "required" or map[unknown]`
5952 6286
5953 Controls which tool the Responses backend uses when handling a task delegated by the Live model.6287 Controls which tool the Responses backend uses when handling a task delegated by the Live model.
5954 6288
5955 - `LiveToolChoiceEnum = "auto" or "none" or "required"`6289 - `LiveToolChoiceEnum = "auto" or "none" or "required"`
5956 6290
6291 Controls which tool the Responses backend uses when handling a task delegated by the Live model.
6292
5957 - `"auto"`6293 - `"auto"`
5958 6294
5959 - `"none"`6295 - `"none"`
5960 6296
5961 - `"required"`6297 - `"required"`
5962 6298
5963 - `LiveFunctionToolChoiceParam object { name, type }`6299 - `map[unknown]`
5964
5965 - `name: string`
5966
5967 - `type: "function"`
5968
5969 - `"function"`
5970
5971 - `LiveMCPToolChoiceParam object { name, server_label, type }`
5972
5973 - `name: string`
5974
5975 - `server_label: string`
5976
5977 - `type: "mcp"`
5978
5979 - `"mcp"`
5980 6300
5981 - `tools: optional array of FunctionTool or object { type } or object { type } or 3 more`6301 - `tools: optional array of FunctionTool or object { type } or object { type } or 10 more`
5982 6302
5983 Tools available to the Responses backend while it handles tasks delegated by the Live model.6303 Tools available to the Responses backend while it handles tasks delegated by the Live model.
5984 6304
6030 6350
6031 - `"code_interpreter"`6351 - `"code_interpreter"`
6032 6352
6033 - `Shell object { environment, type }`6353 - `Shell object { type, environment }`
6034 6354
6035 A Responses shell tool with a container_auto or container_reference environment. Local execution and domain secrets are not supported.6355 A Responses shell tool. Use a hosted container or return local shell results with response.item.create. Domain secrets are not supported.
6036
6037 - `environment: map[unknown]`
6038 6356
6039 - `type: "shell"`6357 - `type: "shell"`
6040 6358
6041 - `"shell"`6359 - `"shell"`
6042 6360
6043 - `ImageGeneration object { type }`6361 - `environment: optional object { type, file_ids, memory_limit, 2 more } or object { container_id, type } or object { type, skills } or null`
6044 6362
6045 - `type: "image_generation"`6363 - `ContainerAuto object { type, file_ids, memory_limit, 2 more }`
6046 6364
6047 - `"image_generation"`6365 - `type: "container_auto"`
6048 6366
6049 - `type: "responses"`6367 Automatically creates a container for this request
6050 6368
6051 The delegation owner. Always `responses` for tasks handled by the Responses API.6369 - `"container_auto"`
6052 6370
6053 - `"responses"`6371 - `file_ids: optional array of string or null`
6054 6372
6055 - `input: optional array of InitialItem`6373 An optional list of uploaded files to make available to your code.
6056 6374
6057 Ordered text-only history supplied before startup. Supports developer, user, and assistant messages with one text part each; at most 128 messages and 8,192 rendered tokens in total.6375 - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
6058 6376
6059 - `Developer object { content, role, id, 2 more }`6377 The memory limit for the container.
6060 6378
6061 A developer message included in the initial text history of a Live session.6379 - `"1g"`
6062 6380
6063 - `content: array of object { text, type }`6381 - `"4g"`
6064 6382
6065 The message content. Supply exactly one text part for the initial Live conversation history.6383 - `"16g"`
6066 6384
6067 - `text: string`6385 - `"64g"`
6068 6386
6069 The message text to include in the Live session’s initial conversation history.6387 - `network_policy: optional object { type } or object { allowed_domains, type } or null`
6070 6388
6071 - `type: optional "input_text"`6389 Network access policy for the container.
6072 6390
6073 The text content type. Always `input_text`.6391 - `Disabled object { type }`
6074 6392
6075 - `"input_text"`6393 - `type: "disabled"`
6076 6394
6077 - `role: "developer"`6395 Disable outbound network access. Always `disabled`.
6078 6396
6079 The author of this history message. Always `developer`.6397 - `"disabled"`
6080 6398
6081 - `"developer"`6399 - `Allowlist object { allowed_domains, type }`
6082 6400
6083 - `id: optional string or null`6401 - `allowed_domains: array of string`
6084 6402
6085 An optional identifier for the supplied history message. Live uses the message’s role and text to initialize the conversation.6403 A list of allowed domains when type is `allowlist`.
6086 6404
6087 - `status: optional "incomplete" or "completed" or null`6405 - `type: "allowlist"`
6088 6406
6089 The supplied message’s status. Live uses its text as history and does not resume an incomplete message.6407 Allow outbound network access only to specified domains. Always `allowlist`.
6090 6408
6091 - `"incomplete"`6409 - `"allowlist"`
6092 6410
6093 - `"completed"`6411 - `skills: optional array of object { skill_id, type, version } or object { description, name, source, type } or null`
6094 6412
6095 - `type: optional "message"`6413 An optional list of skills referenced by id or inline data.
6414
6415 - `SkillReference object { skill_id, type, version }`
6416
6417 - `skill_id: string`
6418
6419 The ID of the referenced skill.
6420
6421 - `type: "skill_reference"`
6422
6423 References a skill created with the /v1/skills endpoint.
6424
6425 - `"skill_reference"`
6426
6427 - `version: optional string or null`
6428
6429 Optional skill version. Use a positive integer or 'latest'. Omit for default.
6430
6431 - `Inline object { description, name, source, type }`
6432
6433 - `description: string`
6434
6435 The description of the skill.
6436
6437 - `name: string`
6438
6439 The name of the skill.
6440
6441 - `source: object { data, media_type, type }`
6442
6443 Inline skill payload
6444
6445 - `data: string`
6446
6447 Base64-encoded skill zip bundle.
6448
6449 - `media_type: "application/zip"`
6450
6451 The media type of the inline skill payload. Must be `application/zip`.
6452
6453 - `"application/zip"`
6454
6455 - `type: "base64"`
6456
6457 The type of the inline skill source. Must be `base64`.
6458
6459 - `"base64"`
6460
6461 - `type: "inline"`
6462
6463 Defines an inline skill for this request.
6464
6465 - `"inline"`
6466
6467 - `ContainerReference object { container_id, type }`
6468
6469 - `container_id: string`
6470
6471 The ID of the referenced container.
6472
6473 - `type: "container_reference"`
6474
6475 References a container created with the /v1/containers endpoint
6476
6477 - `"container_reference"`
6478
6479 - `Local object { type, skills }`
6480
6481 - `type: "local"`
6482
6483 Use a local computer environment.
6484
6485 - `"local"`
6486
6487 - `skills: optional array of object { description, name, path } or null`
6488
6489 An optional list of skills.
6490
6491 - `description: string`
6492
6493 The description of the skill.
6494
6495 - `name: string`
6496
6497 The name of the skill.
6498
6499 - `path: string`
6500
6501 The path to the directory containing the skill.
6502
6503 - `ImageGeneration object { type }`
6504
6505 - `type: "image_generation"`
6506
6507 - `"image_generation"`
6508
6509 - `Mcp object { type }`
6510
6511 - `type: "mcp"`
6512
6513 - `"mcp"`
6514
6515 - `Custom object { type }`
6516
6517 - `type: "custom"`
6518
6519 - `"custom"`
6520
6521 - `Namespace object { type }`
6522
6523 - `type: "namespace"`
6524
6525 - `"namespace"`
6526
6527 - `ToolSearch object { type }`
6528
6529 - `type: "tool_search"`
6530
6531 - `"tool_search"`
6532
6533 - `ProgrammaticToolCalling object { type }`
6534
6535 - `type: "programmatic_tool_calling"`
6536
6537 - `"programmatic_tool_calling"`
6538
6539 - `Computer object { type }`
6540
6541 - `type: "computer"`
6542
6543 - `"computer"`
6544
6545 - `ApplyPatch object { type }`
6546
6547 - `type: "apply_patch"`
6548
6549 - `"apply_patch"`
6550
6551 - `type: "responses"`
6552
6553 The delegation owner. Always `responses` for tasks handled by the Responses API.
6554
6555 - `"responses"`
6556
6557 - `input: optional array of InitialItem`
6558
6559 Ordered text-only history supplied before startup. Supports developer, user, and assistant messages with one text part each; at most 128 messages and 8,192 rendered tokens in total.
6560
6561 - `Developer object { content, role, id, 2 more }`
6562
6563 A developer message included in the initial text history of a Live session.
6564
6565 - `content: array of object { text, type }`
6566
6567 The message content. Supply exactly one text part for the initial Live conversation history.
6568
6569 - `text: string`
6570
6571 The message text to include in the Live session’s initial conversation history.
6572
6573 - `type: optional "input_text"`
6574
6575 The text content type. Always `input_text`.
6576
6577 - `"input_text"`
6578
6579 - `role: "developer"`
6580
6581 The author of this history message. Always `developer`.
6582
6583 - `"developer"`
6584
6585 - `id: optional string or null`
6586
6587 An optional identifier for the supplied history message. Live uses the message’s role and text to initialize the conversation.
6588
6589 - `status: optional "incomplete" or "completed" or null`
6590
6591 The supplied message’s status. Live uses its text as history and does not resume an incomplete message.
6592
6593 - `"incomplete"`
6594
6595 - `"completed"`
6596
6597 - `type: optional "message"`
6096 6598
6097 The history item type. Always `message`.6599 The history item type. Always `message`.
6098 6600
6350 6852
6351 The voice used for speech generated by the Live model.6853 The voice used for speech generated by the Live model.
6352 6854
6353 - `voice: optional string or "alloy" or "ash" or "aube" or 29 more or CustomVoice`6855 - `voice: optional string or "alloy" or "ash" or "ballad" or 28 more or CustomVoice`
6354 6856
6355 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.6857 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.
6356 6858
6357 - `string`6859 - `string`
6358 6860
6359 - `"alloy" or "ash" or "aube" or 29 more`6861 - `"alloy" or "ash" or "ballad" or 28 more`
6360 6862
6361 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.6863 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.
6362 6864
6364 6866
6365 - `"ash"`6867 - `"ash"`
6366 6868
6367 - `"aube"`
6368
6369 - `"ballad"`6869 - `"ballad"`
6370 6870
6371 - `"beacon"`6871 - `"beacon"`
6562 7062
6563 - `"high"`7063 - `"high"`
6564 7064
6565 - `tool_choice: optional "auto" or "none" or "required" or object { name, type } or object { name, server_label, type }`7065 - `tool_choice: optional "auto" or "none" or "required" or map[unknown]`
6566 7066
6567 Controls which tool the Responses backend uses when handling a task delegated by the Live model.7067 Controls which tool the Responses backend uses when handling a task delegated by the Live model.
6568 7068
6569 - `LiveToolChoiceEnum = "auto" or "none" or "required"`7069 - `LiveToolChoiceEnum = "auto" or "none" or "required"`
6570 7070
7071 Controls which tool the Responses backend uses when handling a task delegated by the Live model.
7072
6571 - `"auto"`7073 - `"auto"`
6572 7074
6573 - `"none"`7075 - `"none"`
6574 7076
6575 - `"required"`7077 - `"required"`
6576 7078
6577 - `LiveFunctionToolChoiceParam object { name, type }`7079 - `map[unknown]`
7080
7081 - `tools: optional array of FunctionTool or object { type } or object { type } or 10 more`
7082
7083 Tools available to the Responses backend while it handles tasks delegated by the Live model.
7084
7085 - `FunctionTool object { name, type, description, 2 more }`
7086
7087 A function tool available to the Responses backend when the Live model delegates a task.
6578 7088
6579 - `name: string`7089 - `name: string`
6580 7090
7091 The name the delegated Responses model uses when calling this function.
7092
6581 - `type: "function"`7093 - `type: "function"`
6582 7094
6583 - `"function"`7095 The tool type. Always `function`.
7096
7097 - `"function"`
7098
7099 - `description: optional string or null`
7100
7101 What the function does and when the delegated Responses model should call it.
7102
7103 - `parameters: optional map[unknown] or null`
7104
7105 A JSON Schema object describing the arguments accepted by the function.
7106
7107 - `strict: optional boolean or null`
7108
7109 Whether the delegated Responses model must follow the function’s parameter schema exactly.
7110
7111 - `WebSearch object { type }`
7112
7113 A web search tool available to the Live session’s Responses backend.
7114
7115 - `type: "web_search"`
7116
7117 The tool type. Always `web_search`.
7118
7119 - `"web_search"`
7120
7121 - `FileSearch object { type }`
7122
7123 - `type: "file_search"`
7124
7125 - `"file_search"`
7126
7127 - `CodeInterpreter object { type }`
7128
7129 - `type: "code_interpreter"`
7130
7131 - `"code_interpreter"`
7132
7133 - `Shell object { type, environment }`
7134
7135 A Responses shell tool. Use a hosted container or return local shell results with response.item.create. Domain secrets are not supported.
7136
7137 - `type: "shell"`
7138
7139 - `"shell"`
7140
7141 - `environment: optional object { type, file_ids, memory_limit, 2 more } or object { container_id, type } or object { type, skills } or null`
7142
7143 - `ContainerAuto object { type, file_ids, memory_limit, 2 more }`
7144
7145 - `type: "container_auto"`
7146
7147 Automatically creates a container for this request
7148
7149 - `"container_auto"`
7150
7151 - `file_ids: optional array of string or null`
7152
7153 An optional list of uploaded files to make available to your code.
7154
7155 - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
7156
7157 The memory limit for the container.
7158
7159 - `"1g"`
7160
7161 - `"4g"`
7162
7163 - `"16g"`
7164
7165 - `"64g"`
7166
7167 - `network_policy: optional object { type } or object { allowed_domains, type } or null`
7168
7169 Network access policy for the container.
7170
7171 - `Disabled object { type }`
7172
7173 - `type: "disabled"`
7174
7175 Disable outbound network access. Always `disabled`.
7176
7177 - `"disabled"`
7178
7179 - `Allowlist object { allowed_domains, type }`
7180
7181 - `allowed_domains: array of string`
7182
7183 A list of allowed domains when type is `allowlist`.
7184
7185 - `type: "allowlist"`
7186
7187 Allow outbound network access only to specified domains. Always `allowlist`.
7188
7189 - `"allowlist"`
7190
7191 - `skills: optional array of object { skill_id, type, version } or object { description, name, source, type } or null`
7192
7193 An optional list of skills referenced by id or inline data.
7194
7195 - `SkillReference object { skill_id, type, version }`
7196
7197 - `skill_id: string`
7198
7199 The ID of the referenced skill.
7200
7201 - `type: "skill_reference"`
7202
7203 References a skill created with the /v1/skills endpoint.
7204
7205 - `"skill_reference"`
7206
7207 - `version: optional string or null`
7208
7209 Optional skill version. Use a positive integer or 'latest'. Omit for default.
7210
7211 - `Inline object { description, name, source, type }`
7212
7213 - `description: string`
7214
7215 The description of the skill.
7216
7217 - `name: string`
7218
7219 The name of the skill.
7220
7221 - `source: object { data, media_type, type }`
7222
7223 Inline skill payload
7224
7225 - `data: string`
7226
7227 Base64-encoded skill zip bundle.
7228
7229 - `media_type: "application/zip"`
7230
7231 The media type of the inline skill payload. Must be `application/zip`.
7232
7233 - `"application/zip"`
7234
7235 - `type: "base64"`
7236
7237 The type of the inline skill source. Must be `base64`.
7238
7239 - `"base64"`
7240
7241 - `type: "inline"`
7242
7243 Defines an inline skill for this request.
7244
7245 - `"inline"`
7246
7247 - `ContainerReference object { container_id, type }`
7248
7249 - `container_id: string`
7250
7251 The ID of the referenced container.
6584 7252
6585 - `LiveMCPToolChoiceParam object { name, server_label, type }`7253 - `type: "container_reference"`
6586 7254
6587 - `name: string`7255 References a container created with the /v1/containers endpoint
6588 7256
6589 - `server_label: string`7257 - `"container_reference"`
6590 7258
6591 - `type: "mcp"`7259 - `Local object { type, skills }`
6592 7260
6593 - `"mcp"`7261 - `type: "local"`
6594 7262
6595 - `tools: optional array of FunctionTool or object { type } or object { type } or 3 more`7263 Use a local computer environment.
6596 7264
6597 Tools available to the Responses backend while it handles tasks delegated by the Live model.7265 - `"local"`
6598 7266
6599 - `FunctionTool object { name, type, description, 2 more }`7267 - `skills: optional array of object { description, name, path } or null`
6600 7268
6601 A function tool available to the Responses backend when the Live model delegates a task.7269 An optional list of skills.
6602 7270
6603 - `name: string`7271 - `description: string`
6604 7272
6605 The name the delegated Responses model uses when calling this function.7273 The description of the skill.
6606 7274
6607 - `type: "function"`7275 - `name: string`
6608 7276
6609 The tool type. Always `function`.7277 The name of the skill.
6610 7278
6611 - `"function"`7279 - `path: string`
6612 7280
6613 - `description: optional string or null`7281 The path to the directory containing the skill.
6614 7282
6615 What the function does and when the delegated Responses model should call it.7283 - `ImageGeneration object { type }`
6616 7284
6617 - `parameters: optional map[unknown] or null`7285 - `type: "image_generation"`
6618 7286
6619 A JSON Schema object describing the arguments accepted by the function.7287 - `"image_generation"`
6620 7288
6621 - `strict: optional boolean or null`7289 - `Mcp object { type }`
6622 7290
6623 Whether the delegated Responses model must follow the function’s parameter schema exactly.7291 - `type: "mcp"`
6624 7292
6625 - `WebSearch object { type }`7293 - `"mcp"`
6626 7294
6627 A web search tool available to the Live session’s Responses backend.7295 - `Custom object { type }`
6628 7296
6629 - `type: "web_search"`7297 - `type: "custom"`
6630 7298
6631 The tool type. Always `web_search`.7299 - `"custom"`
6632 7300
6633 - `"web_search"`7301 - `Namespace object { type }`
6634 7302
6635 - `FileSearch object { type }`7303 - `type: "namespace"`
6636 7304
6637 - `type: "file_search"`7305 - `"namespace"`
6638 7306
6639 - `"file_search"`7307 - `ToolSearch object { type }`
6640 7308
6641 - `CodeInterpreter object { type }`7309 - `type: "tool_search"`
6642 7310
6643 - `type: "code_interpreter"`7311 - `"tool_search"`
6644 7312
6645 - `"code_interpreter"`7313 - `ProgrammaticToolCalling object { type }`
6646 7314
6647 - `Shell object { environment, type }`7315 - `type: "programmatic_tool_calling"`
6648 7316
6649 A Responses shell tool with a container_auto or container_reference environment. Local execution and domain secrets are not supported.7317 - `"programmatic_tool_calling"`
6650 7318
6651 - `environment: map[unknown]`7319 - `Computer object { type }`
6652 7320
6653 - `type: "shell"`7321 - `type: "computer"`
6654 7322
6655 - `"shell"`7323 - `"computer"`
6656 7324
6657 - `ImageGeneration object { type }`7325 - `ApplyPatch object { type }`
6658 7326
6659 - `type: "image_generation"`7327 - `type: "apply_patch"`
6660 7328
6661 - `"image_generation"`7329 - `"apply_patch"`
6662 7330
6663 - `type: "responses"`7331 - `type: "responses"`
6664 7332
7502 8170
7503 The voice used for speech generated by the Live model.8171 The voice used for speech generated by the Live model.
7504 8172
7505 - `voice: optional string or "alloy" or "ash" or "aube" or 29 more or CustomVoice`8173 - `voice: optional string or "alloy" or "ash" or "ballad" or 28 more or CustomVoice`
7506 8174
7507 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.8175 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.
7508 8176
7509 - `string`8177 - `string`
7510 8178
7511 - `"alloy" or "ash" or "aube" or 29 more`8179 - `"alloy" or "ash" or "ballad" or 28 more`
7512 8180
7513 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.8181 The voice used for Live speech, as a built-in voice name or a custom voice object containing its ID. Defaults to `marin` and cannot change after startup.
7514 8182
7516 8184
7517 - `"ash"`8185 - `"ash"`
7518 8186
7519 - `"aube"`
7520
7521 - `"ballad"`8187 - `"ballad"`
7522 8188
7523 - `"beacon"`8189 - `"beacon"`
7714 8380
7715 - `"high"`8381 - `"high"`
7716 8382
7717 - `tool_choice: optional "auto" or "none" or "required" or object { name, type } or object { name, server_label, type }`8383 - `tool_choice: optional "auto" or "none" or "required" or map[unknown]`
7718 8384
7719 Controls which tool the Responses backend uses when handling a task delegated by the Live model.8385 Controls which tool the Responses backend uses when handling a task delegated by the Live model.
7720 8386
7721 - `LiveToolChoiceEnum = "auto" or "none" or "required"`8387 - `LiveToolChoiceEnum = "auto" or "none" or "required"`
7722 8388
8389 Controls which tool the Responses backend uses when handling a task delegated by the Live model.
8390
7723 - `"auto"`8391 - `"auto"`
7724 8392
7725 - `"none"`8393 - `"none"`
7726 8394
7727 - `"required"`8395 - `"required"`
7728 8396
7729 - `LiveFunctionToolChoiceParam object { name, type }`8397 - `map[unknown]`
7730
7731 - `name: string`
7732
7733 - `type: "function"`
7734
7735 - `"function"`
7736
7737 - `LiveMCPToolChoiceParam object { name, server_label, type }`
7738
7739 - `name: string`
7740
7741 - `server_label: string`
7742
7743 - `type: "mcp"`
7744
7745 - `"mcp"`
7746 8398
7747 - `tools: optional array of FunctionTool or object { type } or object { type } or 3 more`8399 - `tools: optional array of FunctionTool or object { type } or object { type } or 10 more`
7748 8400
7749 Tools available to the Responses backend while it handles tasks delegated by the Live model.8401 Tools available to the Responses backend while it handles tasks delegated by the Live model.
7750 8402
7796 8448
7797 - `"code_interpreter"`8449 - `"code_interpreter"`
7798 8450
7799 - `Shell object { environment, type }`8451 - `Shell object { type, environment }`
7800
7801 A Responses shell tool with a container_auto or container_reference environment. Local execution and domain secrets are not supported.
7802 8452
7803 - `environment: map[unknown]`8453 A Responses shell tool. Use a hosted container or return local shell results with response.item.create. Domain secrets are not supported.
7804 8454
7805 - `type: "shell"`8455 - `type: "shell"`
7806 8456
7807 - `"shell"`8457 - `"shell"`
7808 8458
8459 - `environment: optional object { type, file_ids, memory_limit, 2 more } or object { container_id, type } or object { type, skills } or null`
8460
8461 - `ContainerAuto object { type, file_ids, memory_limit, 2 more }`
8462
8463 - `type: "container_auto"`
8464
8465 Automatically creates a container for this request
8466
8467 - `"container_auto"`
8468
8469 - `file_ids: optional array of string or null`
8470
8471 An optional list of uploaded files to make available to your code.
8472
8473 - `memory_limit: optional "1g" or "4g" or "16g" or "64g" or null`
8474
8475 The memory limit for the container.
8476
8477 - `"1g"`
8478
8479 - `"4g"`
8480
8481 - `"16g"`
8482
8483 - `"64g"`
8484
8485 - `network_policy: optional object { type } or object { allowed_domains, type } or null`
8486
8487 Network access policy for the container.
8488
8489 - `Disabled object { type }`
8490
8491 - `type: "disabled"`
8492
8493 Disable outbound network access. Always `disabled`.
8494
8495 - `"disabled"`
8496
8497 - `Allowlist object { allowed_domains, type }`
8498
8499 - `allowed_domains: array of string`
8500
8501 A list of allowed domains when type is `allowlist`.
8502
8503 - `type: "allowlist"`
8504
8505 Allow outbound network access only to specified domains. Always `allowlist`.
8506
8507 - `"allowlist"`
8508
8509 - `skills: optional array of object { skill_id, type, version } or object { description, name, source, type } or null`
8510
8511 An optional list of skills referenced by id or inline data.
8512
8513 - `SkillReference object { skill_id, type, version }`
8514
8515 - `skill_id: string`
8516
8517 The ID of the referenced skill.
8518
8519 - `type: "skill_reference"`
8520
8521 References a skill created with the /v1/skills endpoint.
8522
8523 - `"skill_reference"`
8524
8525 - `version: optional string or null`
8526
8527 Optional skill version. Use a positive integer or 'latest'. Omit for default.
8528
8529 - `Inline object { description, name, source, type }`
8530
8531 - `description: string`
8532
8533 The description of the skill.
8534
8535 - `name: string`
8536
8537 The name of the skill.
8538
8539 - `source: object { data, media_type, type }`
8540
8541 Inline skill payload
8542
8543 - `data: string`
8544
8545 Base64-encoded skill zip bundle.
8546
8547 - `media_type: "application/zip"`
8548
8549 The media type of the inline skill payload. Must be `application/zip`.
8550
8551 - `"application/zip"`
8552
8553 - `type: "base64"`
8554
8555 The type of the inline skill source. Must be `base64`.
8556
8557 - `"base64"`
8558
8559 - `type: "inline"`
8560
8561 Defines an inline skill for this request.
8562
8563 - `"inline"`
8564
8565 - `ContainerReference object { container_id, type }`
8566
8567 - `container_id: string`
8568
8569 The ID of the referenced container.
8570
8571 - `type: "container_reference"`
8572
8573 References a container created with the /v1/containers endpoint
8574
8575 - `"container_reference"`
8576
8577 - `Local object { type, skills }`
8578
8579 - `type: "local"`
8580
8581 Use a local computer environment.
8582
8583 - `"local"`
8584
8585 - `skills: optional array of object { description, name, path } or null`
8586
8587 An optional list of skills.
8588
8589 - `description: string`
8590
8591 The description of the skill.
8592
8593 - `name: string`
8594
8595 The name of the skill.
8596
8597 - `path: string`
8598
8599 The path to the directory containing the skill.
8600
7809 - `ImageGeneration object { type }`8601 - `ImageGeneration object { type }`
7810 8602
7811 - `type: "image_generation"`8603 - `type: "image_generation"`
7812 8604
7813 - `"image_generation"`8605 - `"image_generation"`
7814 8606
8607 - `Mcp object { type }`
8608
8609 - `type: "mcp"`
8610
8611 - `"mcp"`
8612
8613 - `Custom object { type }`
8614
8615 - `type: "custom"`
8616
8617 - `"custom"`
8618
8619 - `Namespace object { type }`
8620
8621 - `type: "namespace"`
8622
8623 - `"namespace"`
8624
8625 - `ToolSearch object { type }`
8626
8627 - `type: "tool_search"`
8628
8629 - `"tool_search"`
8630
8631 - `ProgrammaticToolCalling object { type }`
8632
8633 - `type: "programmatic_tool_calling"`
8634
8635 - `"programmatic_tool_calling"`
8636
8637 - `Computer object { type }`
8638
8639 - `type: "computer"`
8640
8641 - `"computer"`
8642
8643 - `ApplyPatch object { type }`
8644
8645 - `type: "apply_patch"`
8646
8647 - `"apply_patch"`
8648
7815 - `type: "responses"`8649 - `type: "responses"`
7816 8650
7817 The delegation owner. Always `responses` for tasks handled by the Responses API.8651 The delegation owner. Always `responses` for tasks handled by the Responses API.