resources/$shared/index.md +0 −906 deleted
File Deleted View Diff
1# Shared
2
3## Domain Types
4
5### All Models
6
7- `AllModels = string or "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 82 more or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`
8
9 - `string`
10
11 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 82 more`
12
13 - `"gpt-6-astra"`
14
15 - `"gpt-5.6-sol"`
16
17 - `"gpt-5.6-terra"`
18
19 - `"gpt-5.6-luna"`
20
21 - `"gpt-5.5"`
22
23 - `"gpt-5.5-2026-04-23"`
24
25 - `"gpt-5.4"`
26
27 - `"gpt-5.4-mini"`
28
29 - `"gpt-5.4-nano"`
30
31 - `"gpt-5.4-mini-2026-03-17"`
32
33 - `"gpt-5.4-nano-2026-03-17"`
34
35 - `"gpt-5.3-chat-latest"`
36
37 - `"gpt-5.2"`
38
39 - `"gpt-5.2-2025-12-11"`
40
41 - `"gpt-5.2-chat-latest"`
42
43 - `"gpt-5.2-pro"`
44
45 - `"gpt-5.2-pro-2025-12-11"`
46
47 - `"gpt-5.1"`
48
49 - `"gpt-5.1-2025-11-13"`
50
51 - `"gpt-5.1-codex"`
52
53 - `"gpt-5.1-chat-latest"`
54
55 - `"gpt-5"`
56
57 - `"gpt-5-mini"`
58
59 - `"gpt-5-nano"`
60
61 - `"gpt-5-2025-08-07"`
62
63 - `"gpt-5-mini-2025-08-07"`
64
65 - `"gpt-5-nano-2025-08-07"`
66
67 - `"gpt-5-chat-latest"`
68
69 - `"gpt-4.1"`
70
71 - `"gpt-4.1-mini"`
72
73 - `"gpt-4.1-nano"`
74
75 - `"gpt-4.1-2025-04-14"`
76
77 - `"gpt-4.1-mini-2025-04-14"`
78
79 - `"gpt-4.1-nano-2025-04-14"`
80
81 - `"o4-mini"`
82
83 - `"o4-mini-2025-04-16"`
84
85 - `"o3"`
86
87 - `"o3-2025-04-16"`
88
89 - `"o3-mini"`
90
91 - `"o3-mini-2025-01-31"`
92
93 - `"o1"`
94
95 - `"o1-2024-12-17"`
96
97 - `"o1-preview"`
98
99 - `"o1-preview-2024-09-12"`
100
101 - `"o1-mini"`
102
103 - `"o1-mini-2024-09-12"`
104
105 - `"gpt-4o"`
106
107 - `"gpt-4o-2024-11-20"`
108
109 - `"gpt-4o-2024-08-06"`
110
111 - `"gpt-4o-2024-05-13"`
112
113 - `"gpt-audio-mini"`
114
115 - `"gpt-audio-mini-2025-12-15"`
116
117 - `"gpt-4o-audio-preview"`
118
119 - `"gpt-4o-audio-preview-2024-10-01"`
120
121 - `"gpt-4o-audio-preview-2024-12-17"`
122
123 - `"gpt-4o-audio-preview-2025-06-03"`
124
125 - `"gpt-4o-mini-audio-preview"`
126
127 - `"gpt-4o-mini-audio-preview-2024-12-17"`
128
129 - `"gpt-4o-search-preview"`
130
131 - `"gpt-4o-mini-search-preview"`
132
133 - `"gpt-4o-search-preview-2025-03-11"`
134
135 - `"gpt-4o-mini-search-preview-2025-03-11"`
136
137 - `"chatgpt-4o-latest"`
138
139 - `"codex-mini-latest"`
140
141 - `"gpt-4o-mini"`
142
143 - `"gpt-4o-mini-2024-07-18"`
144
145 - `"gpt-4-turbo"`
146
147 - `"gpt-4-turbo-2024-04-09"`
148
149 - `"gpt-4-0125-preview"`
150
151 - `"gpt-4-turbo-preview"`
152
153 - `"gpt-4-1106-preview"`
154
155 - `"gpt-4-vision-preview"`
156
157 - `"gpt-4"`
158
159 - `"gpt-4-0314"`
160
161 - `"gpt-4-0613"`
162
163 - `"gpt-4-32k"`
164
165 - `"gpt-4-32k-0314"`
166
167 - `"gpt-4-32k-0613"`
168
169 - `"gpt-3.5-turbo"`
170
171 - `"gpt-3.5-turbo-16k"`
172
173 - `"gpt-3.5-turbo-0301"`
174
175 - `"gpt-3.5-turbo-0613"`
176
177 - `"gpt-3.5-turbo-1106"`
178
179 - `"gpt-3.5-turbo-0125"`
180
181 - `"gpt-3.5-turbo-16k-0613"`
182
183 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`
184
185 - `"o1-pro"`
186
187 - `"o1-pro-2025-03-19"`
188
189 - `"o3-pro"`
190
191 - `"o3-pro-2025-06-10"`
192
193 - `"o3-deep-research"`
194
195 - `"o3-deep-research-2025-06-26"`
196
197 - `"o4-mini-deep-research"`
198
199 - `"o4-mini-deep-research-2025-06-26"`
200
201 - `"computer-use-preview"`
202
203 - `"computer-use-preview-2025-03-11"`
204
205 - `"gpt-5.5-pro"`
206
207 - `"gpt-5.5-pro-2026-04-23"`
208
209 - `"gpt-5-codex"`
210
211 - `"gpt-5-pro"`
212
213 - `"gpt-5-pro-2025-10-06"`
214
215 - `"gpt-5.1-codex-max"`
216
217 - `"gpt-daybreak-blue-latest"`
218
219 - `"gpt-daybreak-red-latest"`
220
221 - `"gpt-5.6-cyber"`
222
223### Comparison Filter
224
225- `ComparisonFilter object { key, type, value }`
226
227 A filter used to compare a specified attribute key to a given value using a defined comparison operation.
228
229 - `key: string`
230
231 The key to compare against the value.
232
233 - `type: "eq" or "ne" or "gt" or 5 more`
234
235 Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
236
237 - `eq`: equals
238 - `ne`: not equal
239 - `gt`: greater than
240 - `gte`: greater than or equal
241 - `lt`: less than
242 - `lte`: less than or equal
243 - `in`: in
244 - `nin`: not in
245
246 - `"eq"`
247
248 - `"ne"`
249
250 - `"gt"`
251
252 - `"gte"`
253
254 - `"lt"`
255
256 - `"lte"`
257
258 - `"in"`
259
260 - `"nin"`
261
262 - `value: string or number or boolean or array of string or number`
263
264 The value to compare against the attribute key; supports string, number, or boolean types.
265
266 - `string`
267
268 - `number`
269
270 - `boolean`
271
272 - `array of string or number`
273
274 - `string`
275
276 - `number`
277
278### Compound Filter
279
280- `CompoundFilter object { filters, type }`
281
282 Combine multiple filters using `and` or `or`.
283
284 - `filters: array of ComparisonFilter or unknown`
285
286 Array of filters to combine. Items can be `ComparisonFilter` or `CompoundFilter`.
287
288 - `ComparisonFilter object { key, type, value }`
289
290 A filter used to compare a specified attribute key to a given value using a defined comparison operation.
291
292 - `key: string`
293
294 The key to compare against the value.
295
296 - `type: "eq" or "ne" or "gt" or 5 more`
297
298 Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`.
299
300 - `eq`: equals
301 - `ne`: not equal
302 - `gt`: greater than
303 - `gte`: greater than or equal
304 - `lt`: less than
305 - `lte`: less than or equal
306 - `in`: in
307 - `nin`: not in
308
309 - `"eq"`
310
311 - `"ne"`
312
313 - `"gt"`
314
315 - `"gte"`
316
317 - `"lt"`
318
319 - `"lte"`
320
321 - `"in"`
322
323 - `"nin"`
324
325 - `value: string or number or boolean or array of string or number`
326
327 The value to compare against the attribute key; supports string, number, or boolean types.
328
329 - `string`
330
331 - `number`
332
333 - `boolean`
334
335 - `array of string or number`
336
337 - `string`
338
339 - `number`
340
341 - `unknown`
342
343 - `type: "and" or "or"`
344
345 Type of operation: `and` or `or`.
346
347 - `"and"`
348
349 - `"or"`
350
351### Custom Tool Input Format
352
353- `CustomToolInputFormat = object { type } or object { definition, syntax, type }`
354
355 The input format for the custom tool. Default is unconstrained text.
356
357 - `Text object { type }`
358
359 Unconstrained free-form text.
360
361 - `type: "text"`
362
363 Unconstrained text format. Always `text`.
364
365 - `"text"`
366
367 - `Grammar object { definition, syntax, type }`
368
369 A grammar defined by the user.
370
371 - `definition: string`
372
373 The grammar definition.
374
375 - `syntax: "lark" or "regex"`
376
377 The syntax of the grammar definition. One of `lark` or `regex`.
378
379 - `"lark"`
380
381 - `"regex"`
382
383 - `type: "grammar"`
384
385 Grammar format. Always `grammar`.
386
387 - `"grammar"`
388
389### Error Object
390
391- `ErrorObject object { code, message, param, 2 more }`
392
393 - `code: string or null`
394
395 - `message: string`
396
397 - `param: string or null`
398
399 - `type: string`
400
401 - `misalignment: optional object { detailed_explanation, error_type, steer }`
402
403 - `detailed_explanation: optional string`
404
405 The public explanation for this block.
406
407 - `error_type: optional string or "potentially_unintended_data_transfer" or "potentially_unintended_data_access" or "potentially_unintended_destructive_activity" or "other"`
408
409 An optional classification; clients must accept additional values.
410
411 - `string`
412
413 - `SafetyAlertErrorType = "potentially_unintended_data_transfer" or "potentially_unintended_data_access" or "potentially_unintended_destructive_activity" or "other"`
414
415 An optional classification; clients must accept additional values.
416
417 - `"potentially_unintended_data_transfer"`
418
419 - `"potentially_unintended_data_access"`
420
421 - `"potentially_unintended_destructive_activity"`
422
423 - `"other"`
424
425 - `steer: optional object { message }`
426
427 An optional public continuation instruction.
428
429 - `message: string`
430
431 The public continuation instruction.
432
433### Function Definition
434
435- `FunctionDefinition object { name, description, parameters, strict }`
436
437 - `name: string`
438
439 The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
440
441 - `description: optional string`
442
443 A description of what the function does, used by the model to choose when and how to call the function.
444
445 - `parameters: optional FunctionParameters`
446
447 The parameters the functions accepts, described as a JSON Schema object. See the [guide](/api/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.
448
449 Omitting `parameters` defines a function with an empty parameter list.
450
451 - `strict: optional boolean or null`
452
453 Whether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the `parameters` field. Only a subset of JSON Schema is supported when `strict` is `true`. Learn more about Structured Outputs in the [function calling guide](/api/docs/guides/function-calling).
454
455### Function Parameters
456
457- `FunctionParameters = map[unknown]`
458
459 The parameters the functions accepts, described as a JSON Schema object. See the [guide](/api/docs/guides/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format.
460
461 Omitting `parameters` defines a function with an empty parameter list.
462
463### Metadata
464
465- `Metadata = map[string]`
466
467 Set of 16 key-value pairs that can be attached to an object. This can be
468 useful for storing additional information about the object in a structured
469 format, and querying for objects via API or the dashboard.
470
471 Keys are strings with a maximum length of 64 characters. Values are strings
472 with a maximum length of 512 characters.
473
474### Reasoning
475
476- `Reasoning object { context, effort, generate_summary, 2 more }`
477
478 Configuration options for
479 [reasoning models](/api/docs/guides/reasoning).
480
481 - `context: optional "auto" or "current_turn" or "all_turns" or null`
482
483 Controls which reasoning items are rendered back to the model on later turns.
484 If omitted or set to `auto`, the model determines the context mode. The
485 `gpt-5.6` model family defaults to `all_turns`; earlier models default to
486 `current_turn`.
487
488 When returned on a response, this is the effective reasoning context mode
489 used for the response.
490
491 - `"auto"`
492
493 - `"current_turn"`
494
495 - `"all_turns"`
496
497 - `effort: optional ReasoningEffort or null`
498
499 Constrains effort on reasoning for reasoning models. Currently supported
500 values are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.
501 Reducing reasoning effort can result in faster responses and fewer tokens
502 used on reasoning in a response. Not all reasoning models support every
503 value. See the
504 [reasoning guide](/api/docs/guides/reasoning)
505 for model-specific support.
506
507 - `"none"`
508
509 - `"minimal"`
510
511 - `"low"`
512
513 - `"medium"`
514
515 - `"high"`
516
517 - `"xhigh"`
518
519 - `"max"`
520
521 - `generate_summary: optional "auto" or "concise" or "detailed" or null`
522
523 **Deprecated:** use `summary` instead.
524
525 A summary of the reasoning performed by the model. This can be
526 useful for debugging and understanding the model's reasoning process.
527 One of `auto`, `concise`, or `detailed`.
528
529 - `"auto"`
530
531 - `"concise"`
532
533 - `"detailed"`
534
535 - `mode: optional string or "standard" or "pro"`
536
537 Controls the reasoning execution mode for the request.
538
539 When returned on a response, this is the effective execution mode.
540
541 - `string`
542
543 - `"standard" or "pro"`
544
545 Controls the reasoning execution mode for the request.
546
547 When returned on a response, this is the effective execution mode.
548
549 - `"standard"`
550
551 - `"pro"`
552
553 - `summary: optional "auto" or "concise" or "detailed" or null`
554
555 A summary of the reasoning performed by the model. This can be
556 useful for debugging and understanding the model's reasoning process.
557 One of `auto`, `concise`, or `detailed`.
558
559 `concise` is supported for `computer-use-preview` models and all reasoning models after `gpt-5`.
560
561 - `"auto"`
562
563 - `"concise"`
564
565 - `"detailed"`
566
567### Reasoning Effort
568
569- `ReasoningEffort = "none" or "minimal" or "low" or 4 more`
570
571 Constrains effort on reasoning for reasoning models. Currently supported
572 values are `none`, `minimal`, `low`, `medium`, `high`, `xhigh`, and `max`.
573 Reducing reasoning effort can result in faster responses and fewer tokens
574 used on reasoning in a response. Not all reasoning models support every
575 value. See the
576 [reasoning guide](/api/docs/guides/reasoning)
577 for model-specific support.
578
579 - `"none"`
580
581 - `"minimal"`
582
583 - `"low"`
584
585 - `"medium"`
586
587 - `"high"`
588
589 - `"xhigh"`
590
591 - `"max"`
592
593### Response Format JSON Object
594
595- `ResponseFormatJSONObject object { type }`
596
597 JSON object response format. An older method of generating JSON responses.
598 Using `json_schema` is recommended for models that support it. Note that the
599 model will not generate JSON without a system or user message instructing it
600 to do so.
601
602 - `type: "json_object"`
603
604 The type of response format being defined. Always `json_object`.
605
606 - `"json_object"`
607
608### Response Format JSON Schema
609
610- `ResponseFormatJSONSchema object { json_schema, type }`
611
612 JSON Schema response format. Used to generate structured JSON responses.
613 Learn more about [Structured Outputs](/api/docs/guides/structured-outputs).
614
615 - `json_schema: object { name, description, schema, strict }`
616
617 Structured Outputs configuration options, including a JSON Schema.
618
619 - `name: string`
620
621 The name of the response format. Must be a-z, A-Z, 0-9, or contain
622 underscores and dashes, with a maximum length of 64.
623
624 - `description: optional string`
625
626 A description of what the response format is for, used by the model to
627 determine how to respond in the format.
628
629 - `schema: optional map[unknown]`
630
631 The schema for the response format, described as a JSON Schema object.
632 Learn how to build JSON schemas [here](https://json-schema.org/).
633
634 - `strict: optional boolean or null`
635
636 Whether to enable strict schema adherence when generating the output.
637 If set to true, the model will always follow the exact schema defined
638 in the `schema` field. Only a subset of JSON Schema is supported when
639 `strict` is `true`. To learn more, read the [Structured Outputs
640 guide](/api/docs/guides/structured-outputs).
641
642 - `type: "json_schema"`
643
644 The type of response format being defined. Always `json_schema`.
645
646 - `"json_schema"`
647
648### Response Format Text
649
650- `ResponseFormatText object { type }`
651
652 Default response format. Used to generate text responses.
653
654 - `type: "text"`
655
656 The type of response format being defined. Always `text`.
657
658 - `"text"`
659
660### Response Format Text Grammar
661
662- `ResponseFormatTextGrammar object { grammar, type }`
663
664 A custom grammar for the model to follow when generating text.
665 Learn more in the [custom grammars guide](/api/docs/guides/function-calling#context-free-grammars).
666
667 - `grammar: string`
668
669 The custom grammar for the model to follow.
670
671 - `type: "grammar"`
672
673 The type of response format being defined. Always `grammar`.
674
675 - `"grammar"`
676
677### Response Format Text Python
678
679- `ResponseFormatTextPython object { type }`
680
681 Configure the model to generate valid Python code. See the
682 [custom grammars guide](/api/docs/guides/function-calling#context-free-grammars) for more details.
683
684 - `type: "python"`
685
686 The type of response format being defined. Always `python`.
687
688 - `"python"`
689
690### Responses Model
691
692- `ResponsesModel = string or "gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 82 more or "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`
693
694 - `string`
695
696 - `"gpt-6-astra" or "gpt-5.6-sol" or "gpt-5.6-terra" or 82 more`
697
698 - `"gpt-6-astra"`
699
700 - `"gpt-5.6-sol"`
701
702 - `"gpt-5.6-terra"`
703
704 - `"gpt-5.6-luna"`
705
706 - `"gpt-5.5"`
707
708 - `"gpt-5.5-2026-04-23"`
709
710 - `"gpt-5.4"`
711
712 - `"gpt-5.4-mini"`
713
714 - `"gpt-5.4-nano"`
715
716 - `"gpt-5.4-mini-2026-03-17"`
717
718 - `"gpt-5.4-nano-2026-03-17"`
719
720 - `"gpt-5.3-chat-latest"`
721
722 - `"gpt-5.2"`
723
724 - `"gpt-5.2-2025-12-11"`
725
726 - `"gpt-5.2-chat-latest"`
727
728 - `"gpt-5.2-pro"`
729
730 - `"gpt-5.2-pro-2025-12-11"`
731
732 - `"gpt-5.1"`
733
734 - `"gpt-5.1-2025-11-13"`
735
736 - `"gpt-5.1-codex"`
737
738 - `"gpt-5.1-chat-latest"`
739
740 - `"gpt-5"`
741
742 - `"gpt-5-mini"`
743
744 - `"gpt-5-nano"`
745
746 - `"gpt-5-2025-08-07"`
747
748 - `"gpt-5-mini-2025-08-07"`
749
750 - `"gpt-5-nano-2025-08-07"`
751
752 - `"gpt-5-chat-latest"`
753
754 - `"gpt-4.1"`
755
756 - `"gpt-4.1-mini"`
757
758 - `"gpt-4.1-nano"`
759
760 - `"gpt-4.1-2025-04-14"`
761
762 - `"gpt-4.1-mini-2025-04-14"`
763
764 - `"gpt-4.1-nano-2025-04-14"`
765
766 - `"o4-mini"`
767
768 - `"o4-mini-2025-04-16"`
769
770 - `"o3"`
771
772 - `"o3-2025-04-16"`
773
774 - `"o3-mini"`
775
776 - `"o3-mini-2025-01-31"`
777
778 - `"o1"`
779
780 - `"o1-2024-12-17"`
781
782 - `"o1-preview"`
783
784 - `"o1-preview-2024-09-12"`
785
786 - `"o1-mini"`
787
788 - `"o1-mini-2024-09-12"`
789
790 - `"gpt-4o"`
791
792 - `"gpt-4o-2024-11-20"`
793
794 - `"gpt-4o-2024-08-06"`
795
796 - `"gpt-4o-2024-05-13"`
797
798 - `"gpt-audio-mini"`
799
800 - `"gpt-audio-mini-2025-12-15"`
801
802 - `"gpt-4o-audio-preview"`
803
804 - `"gpt-4o-audio-preview-2024-10-01"`
805
806 - `"gpt-4o-audio-preview-2024-12-17"`
807
808 - `"gpt-4o-audio-preview-2025-06-03"`
809
810 - `"gpt-4o-mini-audio-preview"`
811
812 - `"gpt-4o-mini-audio-preview-2024-12-17"`
813
814 - `"gpt-4o-search-preview"`
815
816 - `"gpt-4o-mini-search-preview"`
817
818 - `"gpt-4o-search-preview-2025-03-11"`
819
820 - `"gpt-4o-mini-search-preview-2025-03-11"`
821
822 - `"chatgpt-4o-latest"`
823
824 - `"codex-mini-latest"`
825
826 - `"gpt-4o-mini"`
827
828 - `"gpt-4o-mini-2024-07-18"`
829
830 - `"gpt-4-turbo"`
831
832 - `"gpt-4-turbo-2024-04-09"`
833
834 - `"gpt-4-0125-preview"`
835
836 - `"gpt-4-turbo-preview"`
837
838 - `"gpt-4-1106-preview"`
839
840 - `"gpt-4-vision-preview"`
841
842 - `"gpt-4"`
843
844 - `"gpt-4-0314"`
845
846 - `"gpt-4-0613"`
847
848 - `"gpt-4-32k"`
849
850 - `"gpt-4-32k-0314"`
851
852 - `"gpt-4-32k-0613"`
853
854 - `"gpt-3.5-turbo"`
855
856 - `"gpt-3.5-turbo-16k"`
857
858 - `"gpt-3.5-turbo-0301"`
859
860 - `"gpt-3.5-turbo-0613"`
861
862 - `"gpt-3.5-turbo-1106"`
863
864 - `"gpt-3.5-turbo-0125"`
865
866 - `"gpt-3.5-turbo-16k-0613"`
867
868 - `ResponsesOnlyModel = "o1-pro" or "o1-pro-2025-03-19" or "o3-pro" or 16 more`
869
870 - `"o1-pro"`
871
872 - `"o1-pro-2025-03-19"`
873
874 - `"o3-pro"`
875
876 - `"o3-pro-2025-06-10"`
877
878 - `"o3-deep-research"`
879
880 - `"o3-deep-research-2025-06-26"`
881
882 - `"o4-mini-deep-research"`
883
884 - `"o4-mini-deep-research-2025-06-26"`
885
886 - `"computer-use-preview"`
887
888 - `"computer-use-preview-2025-03-11"`
889
890 - `"gpt-5.5-pro"`
891
892 - `"gpt-5.5-pro-2026-04-23"`
893
894 - `"gpt-5-codex"`
895
896 - `"gpt-5-pro"`
897
898 - `"gpt-5-pro-2025-10-06"`
899
900 - `"gpt-5.1-codex-max"`
901
902 - `"gpt-daybreak-blue-latest"`
903
904 - `"gpt-daybreak-red-latest"`
905
906 - `"gpt-5.6-cyber"`