Skip to main content
POST
Error

Authorizations

x-api-key
string
header
required

Organisation API key. Format: sk_<secret>/<keyname> — the secret portion, a literal slash, and the human-readable key name. The header exulu-api-key is accepted as an alias. A Bearer prefix is tolerated and stripped. Keys with an agent scope are only valid for the scoped agent instance.

Headers

session
string<uuid>
required

Agent session ID whose history should be compacted.

x-exulu-model-override
string

LiteLLM model ID to use for summarisation, overriding the agent's configured model.

Path Parameters

instance
string<uuid>
required

Agent ID (UUID).

Body

application/json
steer
string

Optional freeform instruction appended to the compaction prompt to guide what the summary should emphasise.

Response

Compaction result including the checkpoint message.

Result returned by compactSession — includes the generated checkpoint message and the number of messages replaced.