Memory Stores
Update memories
POST
/memory_stores/{name}:update_memoriesStarts an update that writes conversation memories into the specified memory store. The operation returns a long-running status location for polling the update result.
Path ParametersQuery ParametersHeader Parameters
namestringrequired
The name of the memory store to update.api-versionstringrequired
The API version to use for this operation.Foundry-Featuresstringrequired
A feature flag opt-in required when using preview operations or modifying persisted preview resources.MemoryStores=V1Preview
Request BodyContent-Type: application/json
scopestringrequired
The namespace that logically groups and isolates memories, such as a user ID.items(message | item_reference | output_message | file_search_call | computer_call | computer_call_output | web_search_call | function_call | function_call_output | tool_search_call | tool_search_output | additional_tools | reasoning | compaction | image_generation_call | code_interpreter_call | local_shell_call | local_shell_call_output | shell_call | shell_call_output | apply_patch_call | apply_patch_call_output | mcp_list_tools | mcp_approval_request | mcp_approval_response | mcp_call | custom_tool_call_output | custom_tool_call)[]
Conversation items to be stored in memory.One of the following:
messageOpenAI.EasyInputMessage
A message input to the model with a role indicating instruction following
hierarchy. Instructions given with the developer or system role take
precedence over instructions given with the user role. Messages with the
assistant role are presumed to have been generated by the model in previous
interactions.item_referenceOpenAI.ItemReferenceParam
An internal identifier for an item to reference.output_messageOpenAI.InputItemOutputMessage
An output message from the model.file_search_callOpenAI.InputItemFileSearchToolCall
The results of a file search tool call. See the
file search guide for more information.computer_callOpenAI.InputItemComputerToolCall
A tool call to a computer use tool. See the
computer use guide for more information.computer_call_outputOpenAI.InputItemComputerCallOutputItemParam
The output of a computer tool call.web_search_callOpenAI.InputItemWebSearchToolCall
The results of a web search tool call. See the
web search guide for more information.function_callOpenAI.InputItemFunctionToolCall
A tool call to run a function. See the
function calling guide for more information.function_call_outputOpenAI.InputItemFunctionCallOutputItemParam
The output of a function tool call.tool_search_callOpenAI.InputItemToolSearchCallItemParam
An item representing part of the context for the response to be
generated by the model. Can contain text, images, and audio inputs,
as well as previous assistant responses and tool call outputs.tool_search_outputOpenAI.InputItemToolSearchOutputItemParam
An item representing part of the context for the response to be
generated by the model. Can contain text, images, and audio inputs,
as well as previous assistant responses and tool call outputs.additional_toolsOpenAI.InputItemAdditionalToolsItemParam
An item representing part of the context for the response to be
generated by the model. Can contain text, images, and audio inputs,
as well as previous assistant responses and tool call outputs.reasoningOpenAI.InputItemReasoningItem
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.compactionOpenAI.InputItemCompactionSummaryItemParam
A compaction item generated by the v1/responses/compact API.image_generation_callOpenAI.InputItemImageGenToolCall
An image generation request made by the model.code_interpreter_callOpenAI.InputItemCodeInterpreterToolCall
A tool call to run code.local_shell_callOpenAI.InputItemLocalShellToolCall
A tool call to run a command on the local shell.local_shell_call_outputOpenAI.InputItemLocalShellToolCallOutput
The output of a local shell tool call.shell_callOpenAI.InputItemFunctionShellCallItemParam
A tool representing a request to execute one or more shell commands.shell_call_outputOpenAI.InputItemFunctionShellCallOutputItemParam
The streamed output items emitted by a shell tool call.apply_patch_callOpenAI.InputItemApplyPatchToolCallItemParam
A tool call representing a request to create, delete, or update files using diff patches.apply_patch_call_outputOpenAI.InputItemApplyPatchToolCallOutputItemParam
The streamed output emitted by an apply patch tool call.mcp_list_toolsOpenAI.InputItemMcpListTools
A list of tools available on an MCP server.mcp_approval_requestOpenAI.InputItemMcpApprovalRequest
A request for human approval of a tool invocation.mcp_approval_responseOpenAI.InputItemMcpApprovalResponse
A response to an MCP approval request.mcp_callOpenAI.InputItemMcpToolCall
An invocation of a tool on an MCP server.custom_tool_call_outputOpenAI.InputItemCustomToolCallOutput
The output of a custom tool call from your code, being sent back to the model.custom_tool_callOpenAI.InputItemCustomToolCall
A call to a custom tool created by the model.previous_update_idstring
The unique ID of the previous update request, enabling incremental memory updates from where the last operation left off.update_delayinteger
Timeout period before processing the memory update in seconds.
If a new update request is received during this period, it will cancel the current request and reset the timeout.
Set to 0 to immediately trigger the update without delay.
Defaults to 300 (5 minutes).Responses
update_idstringrequired
The unique ID of this update request. Use this value as previous_update_id in subsequent requests to perform incremental updates.statusenumrequired
The status of the memory update operation. One of "queued", "in_progress", "completed", "failed", or "superseded".queuedin_progresscompletedfailedsuperseded
superseded_bystring
The update_id the operation was superseded by when status is "superseded".resultMemoryStoreUpdateCompletedResult
The result of memory store update operation when status is "completed".memory_operationsMemoryOperation[]required
A list of individual memory operations that were performed during the update.usageMemoryStoreOperationUsagerequired
Usage statistics associated with the memory update operation.errorOpenAI.Error
Error object that describes the error when status is "failed".codestring | nullrequired
messagestringrequired
paramstring | null
typestring
detailsOpenAI.Error[]
additionalInfoobject
debugInfoobject