API Reference

Beta

Responses

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Compact a response

beta.responses.compact(**kwargs) -> BetaCompactedResponse { id, created_at, object, 2 more }

POST/responses/compact

Compact a conversation. Returns a compacted response object.

Learn when and how to compact long-running conversations in the conversation state guide. For ZDR-compatible compaction details, see Compaction (advanced).

ParametersExpand Collapse

model: :"gpt-5.6-sol" | :"gpt-5.6-terra" | :"gpt-5.6-luna" | 99 more | String

Model ID used to generate the response, like gpt-5 or o3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.

input: String | Array[BetaResponseInputItem]

Text, image, or file inputs to the model, used to generate a response

instructions: String

A system (or developer) message inserted into the model’s context. When used along with previous_response_id, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.

previous_response_id: String

The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about conversation state. Cannot be used in conjunction with conversation.

prompt_cache_key: String

A key to use when reading from or writing to the prompt cache.

maxLength64

prompt_cache_options: PromptCacheOptions{ mode, ttl}

Options for prompt caching. Supported for gpt-5.6 and later models. By default, OpenAI automatically chooses one implicit cache breakpoint. You can add explicit breakpoints to content blocks with prompt_cache_breakpoint. Each request can write up to four breakpoints. For cache matching, OpenAI considers up to the latest 80 breakpoints in the conversation, without a content-block lookback limit. Set mode to explicit to disable the implicit breakpoint. The ttl defaults to 30m, which is currently the only supported value. See the prompt caching guide for current details.

Deprecatedprompt_cache_retention: :in_memory | :"24h"

How long to retain a prompt cache entry created by this request.

service_tier: :auto | :default | :fast | 2 more

Specifies the processing type used for serving the request. - If set to ‘auto’, then the request will be processed with the service tier configured in the Project settings. Unless otherwise configured, the Project will use ‘default’. - If set to ‘default’, then the request will be processed with the standard pricing and performance for the selected model. - If set to ‘flex’, then the request will be processed with the Flex Processing service tier. - To opt-in to Fast mode at the request level, include the service_tier=fast or service_tier=priority parameter for Responses or Chat Completions. The response will show service_tier=priority regardless of if you specify service_tier=fast or priority in your request. - When not set, the default behavior is ‘auto’. When the service_tier parameter is set, the response body will include the service_tier value based on the processing mode actually used to serve the request. This response value may be different from the value set in the parameter.

betas: Array[:"responses_multi_agent=v1"]

ReturnsExpand Collapse

class BetaCompactedResponse { id, created_at, object, 2 more }

id: String

The unique identifier for the compacted response.

created_at: Integer

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

formatunixtime

object: :"response.compaction"

The object type. Always response.compaction.

output: Array[BetaResponseOutputItem]

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

usage: BetaResponseUsage { input_tokens, input_tokens_details, output_tokens, 2 more }

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

Compact a response

Ruby

HTTP

Python

TypeScript

Go

Ruby

Java

CLI Tool

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

beta_compacted_response = openai.beta.responses.compact(model: :"gpt-5.6-sol")

puts(beta_compacted_response)

{
  "id": "resp_001",
  "object": "response.compaction",
  "created_at": 1764967971,
  "output": [
    {
      "id": "msg_000",
      "type": "message",
      "status": "completed",
      "content": [
        {
          "type": "input_text",
          "text": "Create a simple landing page for a dog petting cafe."
        }
      ],
      "role": "user"
    },
    {
      "id": "cmp_001",
      "type": "compaction",
      "encrypted_content": "gAAAAABpM0Yj-...="
    }
  ],
  "usage": {
    "input_tokens": 139,
    "input_tokens_details": {
      "cached_tokens": 0,
      "cache_write_tokens": 0
    },
    "output_tokens": 438,
    "output_tokens_details": {
      "reasoning_tokens": 64
    },
    "total_tokens": 577
  }
}

Returns Examples

{
  "id": "resp_001",
  "object": "response.compaction",
  "created_at": 1764967971,
  "output": [
    {
      "id": "msg_000",
      "type": "message",
      "status": "completed",
      "content": [
        {
          "type": "input_text",
          "text": "Create a simple landing page for a dog petting cafe."
        }
      ],
      "role": "user"
    },
    {
      "id": "cmp_001",
      "type": "compaction",
      "encrypted_content": "gAAAAABpM0Yj-...="
    }
  ],
  "usage": {
    "input_tokens": 139,
    "input_tokens_details": {
      "cached_tokens": 0,
      "cache_write_tokens": 0
    },
    "output_tokens": 438,
    "output_tokens_details": {
      "reasoning_tokens": 64
    },
    "total_tokens": 577
  }
}