Expand description
Shared model metadata types exchanged between Codex services and clients.
These types are serialized across core, TUI, app-server, and SDK boundaries, so field defaults are used to preserve compatibility when older payloads omit newly introduced attributes.
Structs§
- Approval
Messages - Auto
Review Messages - Client
Version - Semantic version triple encoded as an array in JSON (e.g. [0, 62, 0]).
- Config
Shell Tool Type Iter - An iterator over the variants of ConfigShellToolType
- Input
Modality Iter - An iterator over the variants of InputModality
- Model
Availability Nux - Model
Info - Model metadata returned by the Codex backend
/modelsendpoint. - Model
Info Upgrade - Model
Instructions Variables - Model
Messages - A strongly-typed template for assembling model instructions and developer messages. If instructions_* is populated and valid, it will override base_instructions.
- Model
Preset - Metadata describing a Codex-supported model.
- Model
Service Tier - Model
Upgrade - Model
Visibility Iter - An iterator over the variants of ModelVisibility
- Models
Response - Response wrapper for
/models. - Permission
Messages - Reasoning
Effort Preset - A reasoning effort option that can be surfaced for a model.
- Truncation
Policy Config
Enums§
- Apply
Patch Tool Type - Config
Shell Tool Type - Shell execution capability for a model.
- Input
Modality - Canonical user-input modality tags advertised by a model.
- Model
Visibility - Visibility of a model in the picker or APIs.
- Reasoning
Effort - See https://platform.openai.com/docs/guides/reasoning?api-mode=responses#get-started-with-reasoning
- Tool
Mode - Truncation
Mode - Server-provided truncation policy metadata for a model.
- WebSearch
Tool Type
Constants§
Functions§
- default_
input_ modalities - Backward-compatible default when
input_modalitiesis omitted on the wire.