id: str

The unique identifier for the compacted response.

created_at: int

Unix timestamp (in seconds) when the compacted conversation was created.

formatunixtime
object: Literal["response.compaction"]

The object type. Always response.compaction.

output: List[BetaResponseOutputItem]

The compacted list of output items. This is a list of all user messages, followed by a single compaction item.

One of the following:
class BetaResponseOutputMessage: …

An output message from the model.

id: str

The unique ID of the output message.

content: List[Content]

The content of the output message.

One of the following:
class BetaResponseOutputText: …

A text output from the model.

annotations: List[Annotation]

The annotations of the text output.

One of the following:
class AnnotationFileCitation: …

A citation to a file.

file_id: str

The ID of the file.

filename: str

The filename of the file cited.

index: int

The index in the output text at which to insert the file citation.

type: Literal["file_citation"]

The type of the file citation. Always file_citation.

class AnnotationURLCitation: …

A citation for a web resource used to generate a model response.

end_index: int

The index of the last character of the URL citation in the message.

start_index: int

The index of the first character of the URL citation in the message.

title: str

The title of the web resource.

type: Literal["url_citation"]

The type of the URL citation. Always url_citation.

url: str

The URL of the web resource.

formaturi
class AnnotationContainerFileCitation: …

A citation for a container file used to generate a model response.

container_id: str

The ID of the container file.

end_index: int

The index of the last character of the container file citation in the message.

file_id: str

The ID of the file.

filename: str

The filename of the container file cited.

start_index: int

The index of the first character of the container file citation in the message.

type: Literal["container_file_citation"]

The type of the container file citation. Always container_file_citation.

class AnnotationFilePath: …

A path to a file.

file_id: str

The ID of the file.

index: int

The index of the file in the list of files.

type: Literal["file_path"]

The type of the file path. Always file_path.

text: str

The text output from the model.

type: Literal["output_text"]

The type of the output text. Always output_text.

logprobs: Optional[List[Logprob]]
token: str
bytes: List[int]
logprob: float
top_logprobs: List[LogprobTopLogprob]
token: str
bytes: List[int]
logprob: float
class BetaResponseOutputRefusal: …

A refusal from the model.

refusal: str

The refusal explanation from the model.

type: Literal["refusal"]

The type of the refusal. Always refusal.

role: Literal["assistant"]

The role of the output message. Always assistant.

status: Literal["in_progress", "completed", "incomplete"]

The status of the message input. One of in_progress, completed, or incomplete. Populated when input items are returned via API.

One of the following:
"in_progress"
"completed"
"incomplete"
type: Literal["message"]

The type of the output message. Always message.

agent: Optional[Agent]

The agent that produced this item.

agent_name: str

The canonical name of the agent that produced this item.

phase: Optional[Literal["commentary", "final_answer"]]

Labels an assistant message as intermediate commentary (commentary) or the final answer (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. Not used for user messages.

One of the following:
"commentary"
"final_answer"
class BetaResponseFileSearchToolCall: …

The results of a file search tool call. See the file search guide for more information.

id: str

The unique ID of the file search tool call.

queries: List[str]

The queries used to search for files.

status: Literal["in_progress", "searching", "completed", 2 more]

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

One of the following:
"in_progress"
"searching"
"completed"
"incomplete"
"failed"
type: Literal["file_search_call"]

The type of the file search tool call. Always file_search_call.

agent: Optional[Agent]

The agent that produced this item.

agent_name: str

The canonical name of the agent that produced this item.

results: Optional[List[Result]]

The results of the file search tool call.

attributes: Optional[Dict[str, Union[str, float, bool]]]

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.

One of the following:
str
float
bool
file_id: Optional[str]

The unique ID of the file.

filename: Optional[str]

The name of the file.

score: Optional[float]

The relevance score of the file - a value between 0 and 1.

formatfloat
text: Optional[str]

The text that was retrieved from the file.

class BetaResponseFunctionToolCall: …

A tool call to run a function. See the function calling guide for more information.

arguments: str

A JSON string of the arguments to pass to the function.

call_id: str

The unique ID of the function tool call generated by the model.

name: str

The name of the function to run.

type: Literal["function_call"]

The type of the function tool call. Always function_call.

id: Optional[str]

The unique ID of the function tool call.

agent: Optional[Agent]

The agent that produced this item.

agent_name: str

The canonical name of the agent that produced this item.

async_: Optional[bool]

Whether the function tool call runs asynchronously.

caller: Optional[Caller]

The execution context that produced this tool call.

One of the following:
class CallerDirect: …
type: Literal["direct"]
class CallerProgram: …
caller_id: str

The call ID of the program item that produced this tool call.

type: Literal["program"]
namespace: Optional[str]

The namespace of the function to run.

status: Optional[Literal["in_progress", "completed", "incomplete"]]

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

One of the following:
"in_progress"
"completed"
"incomplete"
class BetaResponseFunctionToolCallOutputItem: …
id: str

The unique ID of the function call tool output.

output: Union[str, List[OutputOutputContentList]]

The output from the function call generated by your code. Can be a string or an list of output content.

One of the following:
str

A string of the output of the function call.

List[OutputOutputContentList]

Text, image, or file output of the function call.

One of the following:
class BetaResponseInputText: …

A text input to the model.

text: str

The text input to the model.

type: Literal["input_text"]

The type of the input item. Always input_text.

prompt_cache_breakpoint: Optional[PromptCacheBreakpoint]

Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: Literal["explicit"]

The breakpoint mode. Always explicit.

ttl: Optional[Literal["30m", "12h"]]

The minimum lifetime of this cache breakpoint. Defaults to the request TTL.

One of the following:
"30m"
"12h"
class BetaResponseInputImage: …

An image input to the model. Learn about image inputs.

detail: BetaImageDetail

The detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.

type: Literal["input_image"]

The type of the input item. Always input_image.

file_id: Optional[str]

The ID of the file to be sent to the model.

image_url: Optional[str]

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

formaturi
prompt_cache_breakpoint: Optional[PromptCacheBreakpoint]

Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: Literal["explicit"]

The breakpoint mode. Always explicit.

ttl: Optional[Literal["30m", "12h"]]

The minimum lifetime of this cache breakpoint. Defaults to the request TTL.

One of the following:
"30m"
"12h"
class BetaResponseInputFile: …

A file input to the model.

type: Literal["input_file"]

The type of the input item. Always input_file.

detail: Optional[Literal["auto", "low", "high"]]

The detail level of the file to be sent to the model. Use auto to let the system select the detail level; for GPT-5.6 and later models, auto uses high-quality rendering, which may increase input token usage. Use low for lower-cost rendering, or high to render the file at higher quality. Defaults to auto.

One of the following:
"auto"
"low"
"high"
file_data: Optional[str]

The content of the file to be sent to the model.

file_id: Optional[str]

The ID of the file to be sent to the model.

file_url: Optional[str]

The URL of the file to be sent to the model.

formaturi
filename: Optional[str]

The name of the file to be sent to the model.

prompt_cache_breakpoint: Optional[PromptCacheBreakpoint]

Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: Literal["explicit"]

The breakpoint mode. Always explicit.

ttl: Optional[Literal["30m", "12h"]]

The minimum lifetime of this cache breakpoint. Defaults to the request TTL.

One of the following:
"30m"
"12h"
status: Literal["in_progress", "completed", "incomplete"]

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

One of the following:
"in_progress"
"completed"
"incomplete"
type: Literal["function_call_output"]

The type of the function tool call output. Always function_call_output.

agent: Optional[Agent]

The agent that produced this item.

agent_name: str

The canonical name of the agent that produced this item.

call_id: Optional[str]

The unique ID of the function tool call generated by the model.

caller: Optional[Caller]

The execution context that produced this tool call.

One of the following:
class CallerDirect: …
type: Literal["direct"]

The caller type. Always direct.

class CallerProgram: …
caller_id: str

The call ID of the program item that produced this tool call.

minLength1
maxLength64
type: Literal["program"]

The caller type. Always program.

created_by: Optional[str]

The identifier of the actor that created the item.

name: Optional[str]

The name of the tool that produced the output.

namespace: Optional[str]

The namespace of the tool that produced the output.

class AgentMessage: …
id: str

The unique ID of the agent message.

author: str

The sending agent identity.

content: List[AgentMessageContent]

Encrypted content sent between agents.

One of the following:
class BetaResponseInputText: …

A text input to the model.

text: str

The text input to the model.

type: Literal["input_text"]

The type of the input item. Always input_text.

prompt_cache_breakpoint: Optional[PromptCacheBreakpoint]

Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: Literal["explicit"]

The breakpoint mode. Always explicit.

ttl: Optional[Literal["30m", "12h"]]

The minimum lifetime of this cache breakpoint. Defaults to the request TTL.

One of the following:
"30m"
"12h"
class BetaResponseOutputText: …

A text output from the model.

annotations: List[Annotation]

The annotations of the text output.

One of the following:
class AnnotationFileCitation: …

A citation to a file.

file_id: str

The ID of the file.

filename: str

The filename of the file cited.

index: int

The index in the output text at which to insert the file citation.

type: Literal["file_citation"]

The type of the file citation. Always file_citation.

class AnnotationURLCitation: …

A citation for a web resource used to generate a model response.

end_index: int

The index of the last character of the URL citation in the message.

start_index: int

The index of the first character of the URL citation in the message.

title: str

The title of the web resource.

type: Literal["url_citation"]

The type of the URL citation. Always url_citation.

url: str

The URL of the web resource.

formaturi
class AnnotationContainerFileCitation: …

A citation for a container file used to generate a model response.

container_id: str

The ID of the container file.

end_index: int

The index of the last character of the container file citation in the message.

file_id: str

The ID of the file.

filename: str

The filename of the container file cited.

start_index: int

The index of the first character of the container file citation in the message.

type: Literal["container_file_citation"]

The type of the container file citation. Always container_file_citation.

class AnnotationFilePath: …

A path to a file.

file_id: str

The ID of the file.

index: int

The index of the file in the list of files.

type: Literal["file_path"]

The type of the file path. Always file_path.

text: str

The text output from the model.

type: Literal["output_text"]

The type of the output text. Always output_text.

logprobs: Optional[List[Logprob]]
token: str
bytes: List[int]
logprob: float
top_logprobs: List[LogprobTopLogprob]
token: str
bytes: List[int]
logprob: float
class AgentMessageContentText: …

A text content.

text: str
type: Literal["text"]
class AgentMessageContentSummaryText: …

A summary text from the model.

text: str

A summary of the reasoning output from the model so far.

type: Literal["summary_text"]

The type of the object. Always summary_text.

class AgentMessageContentReasoningText: …

Reasoning text from the model.

text: str

The reasoning text from the model.

type: Literal["reasoning_text"]

The type of the reasoning text. Always reasoning_text.

class BetaResponseOutputRefusal: …

A refusal from the model.

refusal: str

The refusal explanation from the model.

type: Literal["refusal"]

The type of the refusal. Always refusal.

class BetaResponseInputImage: …

An image input to the model. Learn about image inputs.

detail: BetaImageDetail

The detail level of the image to be sent to the model. One of high, low, auto, or original. Defaults to auto.

type: Literal["input_image"]

The type of the input item. Always input_image.

file_id: Optional[str]

The ID of the file to be sent to the model.

image_url: Optional[str]

The URL of the image to be sent to the model. A fully qualified URL or base64 encoded image in a data URL.

formaturi
prompt_cache_breakpoint: Optional[PromptCacheBreakpoint]

Marks the exact end of a reusable prompt prefix. When ttl is omitted, the breakpoint inherits the request’s prompt_cache_options.ttl; the boundary is not rounded to a token block.

mode: Literal["explicit"]

The breakpoint mode. Always explicit.

ttl: Optional[Literal["30m", "12h"]]

The minimum lifetime of this cache breakpoint. Defaults to the request TTL.

One of the following:
"30m"
"12h"
class AgentMessageContentComputerScreenshot: …

A screenshot of a computer.

class BetaResponseInputFile: …

A file input to the model.

class AgentMessageContentEncryptedContent: …

Opaque encrypted content that Responses API decrypts inside trusted model execution.

recipient: str

The destination agent identity.

type: Literal["agent_message"]

The type of the item. Always agent_message.

agent: Optional[AgentMessageAgent]

The agent that produced this item.

class MultiAgentCall: …
class MultiAgentCallOutput: …
class BetaResponseFunctionWebSearch: …

The results of a web search tool call. See the web search guide for more information.

class BetaResponseComputerToolCall: …

A tool call to a computer use tool. See the computer use guide for more information.

class BetaResponseComputerToolCallOutputItem: …
class BetaResponseReasoningItem: …

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 Program: …
class ProgramOutput: …
class BetaResponseToolSearchCall: …
class BetaResponseToolSearchOutputItem: …
class AdditionalTools: …
class BetaResponseCompactionItem: …

A compaction item generated by the v1/responses/compact API.

class ImageGenerationCall: …

An image generation request made by the model.

class BetaResponseCodeInterpreterToolCall: …

A tool call to run code.

class LocalShellCall: …

A tool call to run a command on the local shell.

class LocalShellCallOutput: …

The output of a local shell tool call.

class BetaResponseFunctionShellToolCall: …

A tool call that executes one or more shell commands in a managed environment.

class BetaResponseFunctionShellToolCallOutput: …

The output of a shell tool call that was emitted.

class BetaResponseApplyPatchToolCall: …

A tool call that applies file diffs by creating, deleting, or updating files.

class BetaResponseApplyPatchToolCallOutput: …

The output emitted by an apply patch tool call.

class McpCall: …

An invocation of a tool on an MCP server.

class McpListTools: …

A list of tools available on an MCP server.

class McpApprovalRequest: …

A request for human approval of a tool invocation.

class McpApprovalResponse: …

A response to an MCP approval request.

class BetaResponseCustomToolCall: …

A call to a custom tool created by the model.

class BetaResponseCustomToolCallOutputItem: …

The output of a custom tool call from your code, being sent back to the model.

usage: BetaResponseUsage

Token accounting for the compaction pass, including cached, reasoning, and total tokens.