Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required
Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

objectiveId
string
required

The ID of the objective. Supports "external_id:" prefix for external IDs.

Example:

"obj_01HXKD2E5NQM3T9AYWCFQAZGFV"

Body

application/json

Compact objective request. Compaction is queued for a busy agent loop and starts immediately for a waiting objective.

compactionConfig
object

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
object
required

Metadata for ephemeral operations and activities (e.g., objectives, executions, runs)

objectiveId
string
required
read-only

The objective this action was sent to.

Example:

"obj_01HXKD2E5NQM3T9AYWCFQAZGFV"

data
object
required

ObjectiveQueuedActionData is the action to perform.

state
enum<string>
required
read-only
Available options:
STATE_UNSPECIFIED,
STATE_QUEUED,
STATE_SENT,
STATE_REMOVED,
STATE_DISCARDED
sentAt
string<date-time>
read-only

When the agent loop picked the action up. Unset until the action is sent.

objectiveEventId
string
read-only

The conversation event a sent user message became. Unset for other actions and for user messages that have not been sent.