Compact an objective
Compacts an objective’s conversation, optionally overriding the variation’s compaction config. Compaction is always recorded as a queued action: a waiting objective starts it immediately, and an objective whose agent loop is busy runs it before its next assistant turn.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
The ID of the objective. Supports "external_id:" prefix for external IDs.
"obj_01HXKD2E5NQM3T9AYWCFQAZGFV"
Body
Compact objective request. Compaction is queued for a busy agent loop and starts immediately for a waiting objective.
Optional compaction config override. When not set, uses the variation's compaction_config.
Response
OK
ObjectiveQueuedAction is work sent to an objective while its agent loop was busy. The agent picks queued actions up in order at the next boundary where it can act on them: after its current tool calls settle, before its next assistant turn. Until then a queued action can be removed and the agent never learns about it.
Metadata for ephemeral operations and activities (e.g., objectives, executions, runs)
The objective this action was sent to.
"obj_01HXKD2E5NQM3T9AYWCFQAZGFV"
ObjectiveQueuedActionData is the action to perform.
- Option 1
- Option 2
- Option 3
STATE_UNSPECIFIED, STATE_QUEUED, STATE_SENT, STATE_REMOVED, STATE_DISCARDED When the agent loop picked the action up. Unset until the action is sent.
The conversation event a sent user message became. Unset for other actions and for user messages that have not been sent.