Module models

Structs§

ActivePermissionProfile: Metadata for the named or implicit built-in permissions profile that produced the active PermissionProfile.
AdditionalPermissionProfile: Partial permission overlay used for per-command requests and approved session/turn grants.
BaseInstructions: Base instructions for the model in a thread. Corresponds to the instructions field in the ResponsesAPI.
FileSystemPermissions
FunctionCallOutputPayload: The payload we send back to OpenAI when reporting a tool call result.
InternalChatMessageMetadataPassthrough: Internal Responses API passthrough metadata copied into underlying chat messages.
LegacyReadWriteRoots
LocalShellExecAction
NetworkPermissions
SearchToolCallParams
ShellCommandToolCallParams: If the name of a ResponseItem::FunctionCall is shell_command, the arguments field should deserialize to this struct.

AgentMessageInputContent
ContentItem
FunctionCallOutputBody
FunctionCallOutputContentItem: Responses API compatible content items that can be returned by a tool call. This is a subset of ContentItem with the types we support as function call outputs.
ImageDetail
LocalImagePreparation
LocalShellAction
LocalShellStatus
ManagedFileSystemPermissions: Filesystem permissions for profiles where Codex owns sandbox construction.
MessagePhase: Classifies an assistant message as interim commentary or final answer text.
PermissionProfile: Canonical active runtime permissions for a conversation, turn, or command.
ReasoningItemContent
ReasoningItemReasoningSummary
ResponseInputItem
ResponseItem
SandboxEnforcement
SandboxPermissions: Controls the per-command sandbox override requested by a shell-like tool call.
WebSearchAction

BASE_INSTRUCTIONS_DEFAULT
BUILT_IN_PERMISSION_PROFILE_DANGER_FULL_ACCESS: Reserved identifier for the built-in full-access permission profile.
BUILT_IN_PERMISSION_PROFILE_READ_ONLY: Reserved identifier for the built-in read-only permission profile.
BUILT_IN_PERMISSION_PROFILE_WORKSPACE: Reserved identifier for the built-in workspace-write permission profile.
DEFAULT_IMAGE_DETAIL
VIEW_IMAGE_TOOL_NAME

audio_close_tag_text
audio_open_tag_text
format_allow_prefixes
function_call_output_content_items_to_text: Converts structured function-call output content into plain text for human-readable surfaces.
image_close_tag_text
image_open_tag_text
is_audio_close_tag_text
is_audio_open_tag_text
is_image_close_tag_text
is_image_open_tag_text
is_local_audio_close_tag_text
is_local_audio_open_tag_text
is_local_image_close_tag_text
is_local_image_open_tag_text
local_audio_label_text
local_audio_open_tag_text_with_path
local_image_content_items_with_label_number
local_image_label_text
local_image_open_tag_text_with_path
plaintext_agent_message_content: Returns the locally readable text when an agent message is entirely plaintext.