Skip to main content Module responses Copy item path Source pub use crate::types::ImageDetail ;pub use crate::types::ReasoningEffort ;AnyItemReference ApplyPatchCreateFileOperation Instruction describing how to create a file via the apply_patch tool. ApplyPatchCreateFileOperationParam Instruction for creating a new file via the apply_patch tool. ApplyPatchDeleteFileOperation Instruction describing how to delete a file via the apply_patch tool. ApplyPatchDeleteFileOperationParam Instruction for deleting an existing file via the apply_patch tool. ApplyPatchToolCall A tool call that applies file diffs by creating, deleting, or updating files. ApplyPatchToolCallItemParam A tool call representing a request to create, delete, or update files using diff patches. ApplyPatchToolCallOutput The output emitted by an apply patch tool call. ApplyPatchToolCallOutputItemParam The streamed output emitted by an apply patch tool call. ApplyPatchUpdateFileOperation Instruction describing how to update a file via the apply_patch tool. ApplyPatchUpdateFileOperationParam Instruction for updating an existing file via the apply_patch tool. Billing ClickParam A click action. CodeInterpreterContainerAuto Auto configuration for code interpreter container. CodeInterpreterFile CodeInterpreterOutputImage CodeInterpreterOutputLogs CodeInterpreterTool CodeInterpreterToolArgs Builder for CodeInterpreterTool CodeInterpreterToolCall Output of a code interpreter request. CompactResource The compacted response object. CompactResponseRequest Request to compact a conversation. CompactResponseRequestArgs Builder for CompactResponseRequest CompactionBody A compaction item generated by the /v1/responses/compact API. CompactionSummaryItemParam A compaction item generated by the /v1/responses/compact API. ComparisonFilter Single comparison filter. CompletionTokensDetails Breakdown of tokens used in a completion. CompoundFilter Combine multiple filters using and or or. ComputerCallOutputItemParam ComputerCallSafetyCheckParam ComputerScreenContent ComputerScreenshotImage A computer screenshot image used with the computer use tool. ComputerTool A tool that controls a virtual computer. Learn more about the
computer tool . ComputerToolCall Output from a computer tool call. ComputerUsePreviewTool ComputerUsePreviewToolArgs Builder for ComputerUsePreviewTool ContainerAutoParam Automatically creates a container for the request. ContainerFileCitationBody ContainerNetworkPolicyAllowlistDetails Details for an allowlist network policy. ContainerNetworkPolicyDomainSecretParam A domain-scoped secret injected for allowlisted domains. ContainerReferenceParam References a container created with the /v1/containers endpoint. ContainerReferenceResource A resource reference to a container by ID. ContextManagementParam Context management configuration. Conversation The conversation that this response belonged to. Input items and output items from this
response were automatically added to this conversation. ConversationItemList A list of Conversation items. ConversationResource Represents a conversation object. CoordParam An x/y coordinate pair. CreateConversationItemsQuery Query parameters for creating conversation items. CreateConversationItemsQueryArgs Builder for CreateConversationItemsQuery CreateConversationItemsRequest Request to create conversation items. CreateConversationItemsRequestArgs Builder for CreateConversationItemsRequest CreateConversationRequest Request to create a conversation.
openapi spec type: CreateConversationBody CreateConversationRequestArgs Builder for CreateConversationRequest CreateResponse Request body for POST /v1/responses. Mirrors upstream CreateResponse
field-for-field but uses Dynamo-owned InputParam, which transitively
accepts the relaxed input shapes described in this module’s header. All
other fields reference upstream types verbatim. CreateResponseArgs Builder for CreateResponse CustomGrammarFormatParam CustomToolCall CustomToolCallOutput CustomToolParam CustomToolParamBuilder Builder for CustomToolParam DeleteConversationResponse Represents a deleted conversation. DeleteResponse DoubleClickAction A double click action. DragParam A drag action. EasyInputMessage A simplified message input — the spec-default shape when a client omits the
type discriminator. Shadows upstream EasyInputMessage so the content
field routes through Dynamo’s relaxed EasyInputContent (and transitively
the relaxed InputContent / InputImageContent). Field set is identical to
upstream for drop-in compatibility with construction sites in lib/llm. EasyInputMessageArgs Builder for EasyInputMessage ErrorObject An error that occurred while generating the response. FileCitationBody FilePath FileSearchTool FileSearchToolArgs Builder for FileSearchTool FileSearchToolCall File search tool call output. FileSearchToolCallResult A single result from a file search. FunctionCallOutputItemParam Output from a function call that you’re providing back to the model. FunctionShellAction Shell exec action
Execute a shell command. FunctionShellActionParam Commands and limits describing how to run the shell tool call. FunctionShellCall A tool call that executes one or more shell commands in a managed environment. FunctionShellCallItemParam A tool representing a request to execute one or more shell commands. FunctionShellCallOutput The output of a shell tool call that was emitted. FunctionShellCallOutputContent The content of a shell tool call output that was emitted. FunctionShellCallOutputContentParam Captured stdout and stderr for a portion of a shell tool call output. FunctionShellCallOutputExitOutcome Indicates that the shell commands finished and returned an exit code. FunctionShellCallOutputExitOutcomeParam Indicates that the shell commands finished and returned an exit code. FunctionShellCallOutputItemParam The streamed output items emitted by a shell tool call. FunctionShellToolParam Parameters for the shell function tool. FunctionTool FunctionToolArgs Builder for FunctionTool FunctionToolCall FunctionToolParam A function tool that can be used within a namespace or with tool search. FunctionToolParamArgs Builder for FunctionToolParam GetConversationItemQuery Query parameters for getting a conversation item. GetConversationItemQueryArgs Builder for GetConversationItemQuery GetResponseQuery Query parameters for getting a response. GetResponseQueryArgs Builder for GetResponseQuery HybridSearch ImageGenTool Image generation tool definition. ImageGenToolCall ImageGenToolInputImageMask ImageGenerationArgs Builder for ImageGenTool IncompleteDetails Details about an incomplete response. InlineSkillParam An inline skill definition. InlineSkillSourceParam An inline skill source (base64-encoded zip). InputFileArgs Builder for InputFileContent InputFileContent InputImageArgs Builder for InputImageContent InputImageContent Relaxed counterpart to upstream InputImageContent. detail defaults to
ImageDetail::Auto when the client omits it — OpenAI’s hosted API and the
OpenResponses spec both accept this shape, but upstream’s struct marks
detail as required. InputMessage User / system / developer input message. Shadows upstream InputMessage
so we can route through the Dynamo-owned InputContent chain. InputMessageArgs Builder for InputMessage InputOutputMessage An assistant message echoed back as input for a subsequent turn. Relaxed
compared to upstream OutputMessage: id, status, and content are all
optional. Some clients send a bare assistant shell ({"type":"message", "role":"assistant"}) with no content at all, usually on pure tool-call
turns; treat absent content as an empty vec, same way we treat a missing
id/status. InputOutputTextContent Relaxed counterpart to upstream OutputTextContent for input-side content.
annotations tolerates both missing and explicit null; upstream requires
it to be a present non-null array. InputReasoningItem A reasoning item echoed back as input for a subsequent turn. Relaxed
compared to upstream ReasoningItem: id and summary are both optional. InputTextContent InputTokenDetails ItemReference A reference to an existing item by ID. KeyPressAction A keypress action. ListConversationItemsQuery Query parameters for listing conversation items. ListConversationItemsQueryArgs Builder for ListConversationItemsQuery ListInputItemsQuery Query parameters for listing input items. ListInputItemsQueryArgs Builder for ListInputItemsQuery LocalEnvironmentParam Uses a local computer environment. LocalShellExecAction Define the shape of a local shell action (exec). LocalShellOutput Output from a local shell command execution. LocalShellToolCall LocalShellToolCallOutput Output from a local shell tool call that you’re providing back to the model. LocalSkillParam A local skill available in a local environment. LogProb MCPApprovalRequest MCPApprovalResponse An MCP approval response that you’re providing back to the model. MCPListTools MCPToolCall Output of an MCP server tool invocation. Message MoveParam A mouse move action. NamespaceToolParam Groups function/custom tools under a shared namespace. NamespaceToolParamArgs Builder for NamespaceToolParam OutputMessage A message generated by the model. OutputTextContent A simple text output from the model. OutputTokenDetails Prompt PromptTokensDetails Breakdown of tokens used in a completion. RankingOptions Options for search result ranking. Reasoning o-series reasoning settings. ReasoningArgs Builder for Reasoning ReasoningItem A reasoning item representing the model’s chain of thought, including summary paragraphs. ReasoningTextContent RefusalContent A refusal explanation from the model. Response The complete response returned by the Responses API. ResponseCodeInterpreterCallCodeDeltaEvent ResponseCodeInterpreterCallCodeDoneEvent ResponseCodeInterpreterCallCompletedEvent ResponseCodeInterpreterCallInProgressEvent ResponseCodeInterpreterCallInterpretingEvent ResponseCompletedEvent ResponseContentPartAddedEvent ResponseContentPartDoneEvent ResponseCreatedEvent ResponseCustomToolCallInputDeltaEvent ResponseCustomToolCallInputDoneEvent ResponseErrorEvent ResponseFailedEvent ResponseFileSearchCallCompletedEvent ResponseFileSearchCallInProgressEvent ResponseFileSearchCallSearchingEvent ResponseFormatJsonSchema ResponseFunctionCallArgumentsDeltaEvent ResponseFunctionCallArgumentsDoneEvent ResponseImageGenCallCompletedEvent ResponseImageGenCallGeneratingEvent ResponseImageGenCallInProgressEvent ResponseImageGenCallPartialImageEvent ResponseInProgressEvent ResponseIncompleteEvent ResponseItemList A list of Response items. ResponseLogProb ResponseMCPCallArgumentsDeltaEvent ResponseMCPCallArgumentsDoneEvent ResponseMCPCallCompletedEvent ResponseMCPCallFailedEvent ResponseMCPCallInProgressEvent ResponseMCPListToolsCompletedEvent ResponseMCPListToolsFailedEvent ResponseMCPListToolsInProgressEvent ResponseOutputItemAddedEvent ResponseOutputItemDoneEvent ResponseOutputTextAnnotationAddedEvent ResponseQueuedEvent ResponseReasoningSummaryPartAddedEvent ResponseReasoningSummaryPartDoneEvent ResponseReasoningSummaryTextDeltaEvent ResponseReasoningSummaryTextDoneEvent ResponseReasoningTextDeltaEvent ResponseReasoningTextDoneEvent ResponseRefusalDeltaEvent ResponseRefusalDoneEvent ResponseStreamOptions ResponseTextDeltaEvent ResponseTextDoneEvent ResponseTextParam Configuration for text response format. ResponseTopLobProb ResponseUsage Usage statistics for a response. ResponseWebSearchCallCompletedEvent ResponseWebSearchCallInProgressEvent ResponseWebSearchCallSearchingEvent ScrollParam A scroll action. SkillReferenceParam A skill referenced by ID. SummaryTextContent TextContent TokenCountsBody TokenCountsBodyArgs Builder for TokenCountsBody TokenCountsResource ToolChoiceAllowed ToolChoiceCustom ToolChoiceFunction ToolChoiceMCP ToolSearchCall A tool search call output item. ToolSearchCallItemParam A tool search call input item. ToolSearchOutput A tool search output item. ToolSearchOutputItemParam A tool search output input item. ToolSearchToolParam Hosted or BYOT tool search configuration for deferred tools. ToolSearchToolParamArgs Builder for ToolSearchToolParam TopLogProb TypeParam A typing (text entry) action. UpdateConversationRequest Request to update a conversation. UpdateConversationRequestArgs Builder for UpdateConversationRequest UrlCitationBody WebSearchActionFind WebSearchActionOpenPage WebSearchActionSearch WebSearchActionSearchSource WebSearchApproximateLocation Approximate user location for web search. WebSearchApproximateLocationArgs Builder for WebSearchApproximateLocation WebSearchTool WebSearchToolArgs Builder for WebSearchTool WebSearchToolCall Web search tool call output. WebSearchToolFilters Annotation An annotation that applies to a span of output text. ApplyPatchCallOutputStatus Outcome values reported for apply_patch tool call outputs. ApplyPatchCallOutputStatusParam Outcome values reported for apply_patch tool call outputs. ApplyPatchCallStatus Status values reported for apply_patch tool calls. ApplyPatchCallStatusParam Status values reported for apply_patch tool calls. ApplyPatchOperation One of the create_file, delete_file, or update_file operations applied via apply_patch. ApplyPatchOperationParam One of the create_file, delete_file, or update_file operations supplied to the apply_patch tool. AssistantRole The role for an output message - always assistant.
This type ensures type safety by only allowing the assistant role. ClickButtonType CodeInterpreterToolCallOutput Individual result from a code interpreter: either logs or files. CodeInterpreterToolCallStatus CodeInterpreterToolContainer Container configuration for a code interpreter. ComparisonType CompoundType ComputerAction Represents all user‐triggered actions. ComputerEnvironment ComputerScreenshotImageType ComputerUsePreviewToolArgsError Error type for ComputerUsePreviewToolArgs ContainerNetworkPolicy Network access policy for a container. ConversationItem ConversationParam CustomToolCallOutputOutput CustomToolParamBuilderError Error type for CustomToolParamBuilder CustomToolParamFormat EasyInputContent Content for EasyInputMessage. Shadows upstream’s same-named enum so the
ContentList arm carries Dynamo’s relaxed InputContent (with optional
detail on InputImageContent) instead of upstream’s strict variant. FileSearchToolCallStatus Filter Filters for file search. FunctionCallOutput FunctionCallOutputStatusEnum The status of a function call output. FunctionCallStatus The status of a function call. FunctionShellCallEnvironment The environment for a shell call (response side). FunctionShellCallItemEnvironment The environment for a shell call item (request side). FunctionShellCallItemStatus Status values reported for shell tool calls. FunctionShellCallOutputOutcome Function shell call outcome FunctionShellCallOutputOutcomeParam The exit or timeout outcome associated with this chunk. FunctionShellEnvironment The execution environment for a shell tool — container or local. FunctionToolArgsError Error type for FunctionToolArgs GrammarSyntax ImageGenActionEnum Whether to generate a new image or edit an existing image. ImageGenToolBackground ImageGenToolCallStatus ImageGenToolModeration ImageGenToolOutputFormat ImageGenToolQuality ImageGenToolSize IncludeEnum IncludeParam Additional fields to include in the response. InputContent Parts of an input message: text, image, or file. Mirrors upstream
InputContent but routes InputImage through the Dynamo-owned relaxed
InputImageContent above. InputFidelity InputItem Single input item. Untagged; order matters (most specific first). InputOutputMessageContent Content parts of a prior assistant message presented as input. InputParam Input to a POST /v1/responses request. InputRole The role for an input message - can only be user, system, or developer.
This type ensures type safety by excluding the assistant role (use OutputMessage for that). Instructions Item Structured input/output item, discriminated by type. Mirrors upstream
Item variant-for-variant; only Message and Reasoning use owned types. ItemReferenceType ItemResource ItemResourceItem ListInputItemsOrder Sort order for listing input items. ListOrder The order to return items in. LocalShellCallStatus Status values reported for function shell tool calls. MCPToolCallStatus MessageContent MessageItem Message item within Item. Untagged; disambiguated by the role field:
the Output variant requires role: "assistant" (via AssistantRole,
which is a single-variant enum) and Input requires role in
"user" | "system" | "developer" (via InputRole). A payload with an
unknown role (e.g. "tool") or a missing role produces the generic
untagged-enum error — callers are expected to send a valid role. If you
see the “data did not match any variant of untagged enum” failure on this
type, it is almost always a role mismatch. MessagePhase Labels an assistant message as intermediate commentary or the final answer.
For models like gpt-5.3-codex and beyond, when sending follow-up requests, preserve and resend
phase on all assistant messages — dropping it can degrade performance. MessageRole MessageStatus MessageType NamespaceToolParamTool A function or custom tool that belongs to a namespace. OutputContent OutputItem Output item OutputMessageContent OutputStatus Status of input/output items. PromptCacheRetention The retention policy for the prompt cache. RankVersionType ReasoningSummary ResponseFormat ResponsePromptVariables ResponseStreamEvent Event types for streaming responses from the Responses API Role Role of messages in the API. SearchContentType The type of content to search for. ServiceTier SkillParam A skill parameter — either a reference or inline definition. Status SummaryPart TextResponseFormatConfiguration Tool Definitions for model-callable tools. ToolChoiceAllowedMode ToolChoiceOptions ToolChoiceParam ToolChoiceTypes The type of hosted tool the model should to use. Learn more about
built-in tools . ToolSearchExecutionType Whether tool search was executed by the server or by the client. Truncation Truncation strategies. UpstreamInputContent Parts of a message: text, image, file, or audio. Verbosity o-series reasoning settings. WebSearchApproximateLocationType WebSearchToolArgsError Error type for WebSearchToolArgs WebSearchToolCallAction WebSearchToolCallStatus WebSearchToolSearchContextSize SPEC_NULLABLE_REQUIRED_RESPONSE_FIELDS Fields on upstream Response that the OpenResponses spec requires as
T | null but async-openai declares as Option<T> with
skip_serializing_if = Option::is_none — meaning None disappears from
the wire shape, where the spec wants an explicit null. Input PromptConfig ResponseStream Stream of response events. TextConfig TextResponseFormat