Retrieve an item
Get a single item from a conversation with the given IDs.
ParametersExpand Collapse
ItemRetrieveParams params
Additional fields to include in the response. See the include
parameter for listing Conversation items above for more information.
Additional fields to include in the response. See the include
parameter for listing Conversation items above for more information.
ReturnsExpand Collapse
class ConversationItem: A class that can be one of several variants.union A single item within a conversation. The set of possible types are the same as the output type of a Response object.
A single item within a conversation. The set of possible types are the same as the output type of a Response object.
class Message:A message to or from the model.
A message to or from the model.
List<Content> contentThe content of the message
The content of the message
class ResponseOutputText:A text output from the model.
A text output from the model.
List<Annotation> annotationsThe annotations of the text output.
The annotations of the text output.
class UrlCitation:A citation for a web resource used to generate a model response.
A citation for a web resource used to generate a model response.
class ResponseInputImage:An image input to the model. Learn about image inputs.
An image input to the model. Learn about image inputs.
class ComputerScreenshotContent:A screenshot of a computer.
A screenshot of a computer.
Role roleThe role of the message. One of unknown, user, assistant, system, critic, discriminator, developer, or tool.
The role of the message. One of unknown, user, assistant, system, critic, discriminator, developer, or tool.
class ResponseFunctionToolCallItem:A tool call to run a function. See the
function calling guide for more information.
A tool call to run a function. See the function calling guide for more information.
class ResponseFunctionToolCallOutputItem:
Output outputThe output from the function call generated by your code.
Can be a string or an list of output content.
The output from the function call generated by your code. Can be a string or an list of output content.
List<FunctionAndCustomToolCallOutput>
class ResponseInputImage:An image input to the model. Learn about image inputs.
An image input to the model. Learn about image inputs.
Status statusThe status of the item. One of in_progress, completed, or
incomplete. Populated when items are returned via API.
The status of the item. One of in_progress, completed, or
incomplete. Populated when items are returned via API.
class ResponseFileSearchToolCall:The results of a file search tool call. See the
file search guide for more information.
The results of a file search tool call. See the file search guide for more information.
Status statusThe status of the file search tool call. One of in_progress,
searching, incomplete or failed,
The status of the file search tool call. One of in_progress,
searching, incomplete or failed,
The type of the file search tool call. Always file_search_call.
Optional<List<Result>> resultsThe results of the file search tool call.
The results of the file search tool call.
Optional<Attributes> attributesSet of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard. Keys are strings
with a maximum length of 64 characters. Values are strings with a maximum
length of 512 characters, booleans, or numbers.
Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters, booleans, or numbers.
class ResponseFunctionWebSearch:The results of a web search tool call. See the
web search guide for more information.
The results of a web search tool call. See the web search guide for more information.
Action actionAn object describing the specific action taken in this web search call.
Includes details on how the model used the web (search, open_page, find_in_page).
An object describing the specific action taken in this web search call. Includes details on how the model used the web (search, open_page, find_in_page).
class ResponseComputerToolCall:A tool call to a computer use tool. See the
computer use guide for more information.
A tool call to a computer use tool. See the computer use guide for more information.
Status statusThe status of the item. One of in_progress, completed, or
incomplete. Populated when items are returned via API.
The status of the item. One of in_progress, completed, or
incomplete. Populated when items are returned via API.
Optional<Action> actionA click action.
A click action.
class Click:A click action.
A click action.
class DoubleClick:A double click action.
A double click action.
class Drag:A drag action.
A drag action.
class Scroll:A scroll action.
A scroll action.
Flattened batched actions for computer_use. Each action includes an
type discriminator and action-specific fields.
Flattened batched actions for computer_use. Each action includes an
type discriminator and action-specific fields.
Click
DoubleClick
Drag
Scroll
class ResponseComputerToolCallOutputItem:
A computer screenshot image used with the computer use tool.
A computer screenshot image used with the computer use tool.
Status statusThe status of the message input. One of in_progress, completed, or
incomplete. Populated when input items are returned via API.
The status of the message input. One of in_progress, completed, or
incomplete. Populated when input items are returned via API.
The type of the computer tool call output. Always computer_call_output.
class ResponseToolSearchCall:
class ResponseToolSearchOutputItem:
List<Tool> toolsThe loaded tool definitions returned by tool search.
The loaded tool definitions returned by tool search.
class FunctionTool:Defines a function in your own code the model can choose to call. Learn more about function calling.
Defines a function in your own code the model can choose to call. Learn more about function calling.
class FileSearchTool:A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
The type of the file search tool. Always file_search.
Optional<Filters> filtersA filter to apply.
A filter to apply.
class ComparisonFilter:A filter used to compare a specified attribute key to a given value using a defined comparison operation.
A filter used to compare a specified attribute key to a given value using a defined comparison operation.
class CompoundFilter:Combine multiple filters using and or or.
Combine multiple filters using and or or.
List<Filter> filtersArray of filters to combine. Items can be ComparisonFilter or CompoundFilter.
Array of filters to combine. Items can be ComparisonFilter or CompoundFilter.
class ComparisonFilter:A filter used to compare a specified attribute key to a given value using a defined comparison operation.
A filter used to compare a specified attribute key to a given value using a defined comparison operation.
The maximum number of results to return. This number should be between 1 and 50 inclusive.
Optional<RankingOptions> rankingOptionsRanking options for search.
Ranking options for search.
class ComputerTool:A tool that controls a virtual computer. Learn more about the computer tool.
A tool that controls a virtual computer. Learn more about the computer tool.
class ComputerUsePreviewTool:A tool that controls a virtual computer. Learn more about the computer tool.
A tool that controls a virtual computer. Learn more about the computer tool.
class WebSearchTool:Search the Internet for sources related to the prompt. Learn more about the
web search tool.
Search the Internet for sources related to the prompt. Learn more about the web search tool.
Optional<SearchContextSize> searchContextSizeHigh level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
Optional<UserLocation> userLocationThe approximate location of the user.
The approximate location of the user.
The two-letter ISO country code of the user, e.g. US.
The IANA timezone of the user, e.g. America/Los_Angeles.
Mcp
Optional<AllowedTools> allowedToolsList of allowed tool names or a filter object.
List of allowed tool names or a filter object.
class McpToolFilter:A filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
An OAuth access token that can be used with a remote MCP server, either with a custom MCP server URL or a service connector. Your application must handle the OAuth authorization flow and provide the token here.
Optional<ConnectorId> connectorIdIdentifier for service connectors, like those available in ChatGPT. One of
server_url or connector_id must be provided. Learn more about service
connectors here.
Currently supported connector_id values are:
- Dropbox:
connector_dropbox
- Gmail:
connector_gmail
- Google Calendar:
connector_googlecalendar
- Google Drive:
connector_googledrive
- Microsoft Teams:
connector_microsoftteams
- Outlook Calendar:
connector_outlookcalendar
- Outlook Email:
connector_outlookemail
- SharePoint:
connector_sharepoint
Identifier for service connectors, like those available in ChatGPT. One of
server_url or connector_id must be provided. Learn more about service
connectors here.
Currently supported connector_id values are:
- Dropbox:
connector_dropbox - Gmail:
connector_gmail - Google Calendar:
connector_googlecalendar - Google Drive:
connector_googledrive - Microsoft Teams:
connector_microsoftteams - Outlook Calendar:
connector_outlookcalendar - Outlook Email:
connector_outlookemail - SharePoint:
connector_sharepoint
Optional HTTP headers to send to the MCP server. Use for authentication or other purposes.
Optional<RequireApproval> requireApprovalSpecify which of the MCP server's tools require approval.
Specify which of the MCP server's tools require approval.
class McpToolApprovalFilter:Specify which of the MCP server's tools require approval. Can be
always, never, or a filter object associated with tools
that require approval.
Specify which of the MCP server's tools require approval. Can be
always, never, or a filter object associated with tools
that require approval.
Optional<Always> alwaysA filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
Optional<Never> neverA filter object to specify which tools are allowed.
A filter object to specify which tools are allowed.
Indicates whether or not a tool modifies data or is read-only. If an
MCP server is annotated with readOnlyHint,
it will match this filter.
CodeInterpreter
Container containerThe code interpreter container. Can be a container ID or an object that
specifies uploaded file IDs to make available to your code, along with an
optional memory_limit setting.
The code interpreter container. Can be a container ID or an object that
specifies uploaded file IDs to make available to your code, along with an
optional memory_limit setting.
class CodeInterpreterToolAuto:Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
Configuration for a code interpreter container. Optionally specify the IDs of the files to run the code on.
Optional<NetworkPolicy> networkPolicyNetwork access policy for the container.
Network access policy for the container.
ImageGeneration
The type of the image generation tool. Always image_generation.
Optional<Background> backgroundBackground type for the generated image. One of transparent,
opaque, or auto. Default: auto.
Background type for the generated image. One of transparent,
opaque, or auto. Default: auto.
Optional<InputFidelity> inputFidelityControl how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.
Control how much effort the model will exert to match the style and features, especially facial features, of input images. This parameter is only supported for gpt-image-1 and gpt-image-1.5 and later models, unsupported for gpt-image-1-mini. Supports high and low. Defaults to low.
Optional<InputImageMask> inputImageMaskOptional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
Optional mask for inpainting. Contains image_url
(string, optional) and file_id (string, optional).
Compression level for the output image. Default: 100.
Optional<OutputFormat> outputFormatThe output format of the generated image. One of png, webp, or
jpeg. Default: png.
The output format of the generated image. One of png, webp, or
jpeg. Default: png.
Number of partial images to generate in streaming mode, from 0 (default value) to 3.
class FunctionShellTool:A tool that allows the model to execute shell commands.
A tool that allows the model to execute shell commands.
Optional<Environment> environment
class ContainerAuto:
Automatically creates a container for this request
Optional<NetworkPolicy> networkPolicyNetwork access policy for the container.
Network access policy for the container.
Optional<List<Skill>> skillsAn optional list of skills referenced by id or inline data.
An optional list of skills referenced by id or inline data.
class InlineSkill:
InlineSkillSource sourceInline skill payload
Inline skill payload
class CustomTool:A custom tool that processes input using a specified format. Learn more about custom tools
A custom tool that processes input using a specified format. Learn more about custom tools
class NamespaceTool:Groups function/custom tools under a shared namespace.
Groups function/custom tools under a shared namespace.
List<Tool> toolsThe function/custom tools available inside this namespace.
The function/custom tools available inside this namespace.
class CustomTool:A custom tool that processes input using a specified format. Learn more about custom tools
A custom tool that processes input using a specified format. Learn more about custom tools
class ToolSearchTool:Hosted or BYOT tool search configuration for deferred tools.
Hosted or BYOT tool search configuration for deferred tools.
class WebSearchPreviewTool:This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
This tool searches the web for relevant results to use in a response. Learn more about the web search tool.
Type typeThe type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
The type of the web search tool. One of web_search_preview or web_search_preview_2025_03_11.
Optional<SearchContextSize> searchContextSizeHigh level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
High level guidance for the amount of context window space to use for the search. One of low, medium, or high. medium is the default.
Optional<UserLocation> userLocationThe user's location.
The user's location.
The type of location approximation. Always approximate.
The two-letter ISO country code of the user, e.g. US.
The IANA timezone of the user, e.g. America/Los_Angeles.
class ResponseReasoningItem:A description of the chain of thought used by a reasoning model while generating
a response. Be sure to include these items in your input to the Responses API
for subsequent turns of a conversation if you are manually
managing context.
A description of the chain of thought used by a reasoning model while generating
a response. Be sure to include these items in your input to the Responses API
for subsequent turns of a conversation if you are manually
managing context.
class ResponseCompactionItem:A compaction item generated by the v1/responses/compact API.
A compaction item generated by the v1/responses/compact API.
class ResponseCodeInterpreterToolCall:A tool call to run code.
A tool call to run code.
Optional<List<Output>> outputsThe outputs generated by the code interpreter, such as logs or images.
Can be null if no outputs are available.
The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available.
LocalShellCall
LocalShellCallOutput
class ResponseFunctionShellToolCall:A tool call that executes one or more shell commands in a managed environment.
A tool call that executes one or more shell commands in a managed environment.
Optional<Environment> environmentRepresents the use of a local environment to perform shell actions.
Represents the use of a local environment to perform shell actions.
class ResponseFunctionShellToolCallOutput:The output of a shell tool call that was emitted.
The output of a shell tool call that was emitted.
The maximum length of the shell command output. This is generated by the model and should be passed back with the raw output.
List<Output> outputAn array of shell call output contents
An array of shell call output contents
class ResponseApplyPatchToolCall:A tool call that applies file diffs by creating, deleting, or updating files.
A tool call that applies file diffs by creating, deleting, or updating files.
Operation operationOne of the create_file, delete_file, or update_file operations applied via apply_patch.
One of the create_file, delete_file, or update_file operations applied via apply_patch.
class ResponseApplyPatchToolCallOutput:The output emitted by an apply patch tool call.
The output emitted by an apply patch tool call.
The unique ID of the apply patch tool call output. Populated when this item is returned via API.
McpListTools
McpApprovalResponse
McpCall
class ResponseCustomToolCall:A call to a custom tool created by the model.
A call to a custom tool created by the model.
class ResponseCustomToolCallOutput:The output of a custom tool call from your code, being sent back to the model.
The output of a custom tool call from your code, being sent back to the model.
Output outputThe output from the custom tool call generated by your code.
Can be a string or an list of output content.
The output from the custom tool call generated by your code. Can be a string or an list of output content.
List<FunctionAndCustomToolCallOutput>
class ResponseInputImage:An image input to the model. Learn about image inputs.
An image input to the model. Learn about image inputs.
Retrieve an item
package com.openai.example;
import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.conversations.items.ConversationItem;
import com.openai.models.conversations.items.ItemRetrieveParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
OpenAIClient client = OpenAIOkHttpClient.fromEnv();
ItemRetrieveParams params = ItemRetrieveParams.builder()
.conversationId("conv_123")
.itemId("msg_abc")
.build();
ConversationItem conversationItem = client.conversations().items().retrieve(params);
}
}{
"type": "message",
"id": "msg_abc",
"status": "completed",
"role": "user",
"content": [
{"type": "input_text", "text": "Hello!"}
]
}
Returns Examples
{
"type": "message",
"id": "msg_abc",
"status": "completed",
"role": "user",
"content": [
{"type": "input_text", "text": "Hello!"}
]
}