Sign in

v56

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01142337440.5 KB
ObjectiveService
Objectives

Cancel an objective

Cancels a running or pending objective. The objective's state will be set to STATE_CANCELLED.

post/v1/workspaces/{workspaceId}/objectives/{objectiveId}:cancel

Path parameters

workspaceIdstring required
Example:workspace_01HXKD2E5NQM3T9AYWCF133E3Q
objectiveIdstring required
Example:obj_01HXKD2E5NQM3T9AYWCFQAZGFV

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

Request body

workspaceIdstring
objectiveIdstring

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

reasonstring

Optional reason for cancellation

Example request

{
  "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
  "objectiveId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV"
}

Response

OK

state'STATE_UNSPECIFIED' | 'STATE_PENDING' | 'STATE_RUNNING' | 'STATE_WAITING' | 'STATE_FAILED' | 'STATE_CANCELLED' | 'STATE_FINALIZED' | 'STATE_TIMED_OUT' enum required

The current lifecycle state of the objective.

stateMessagestring

Optional human-readable detail about the current state (e.g. a failure reason).

systemPromptstring required

system_prompt is read-only, derived from the selected variation's prompt

firstUserMessagestring required

The first user message in the LLM chat history, either provided explicitly at creation or rendered from the variation's first_user_message_template.

parentObjectiveIdstring

A parent objective means the objective was spawned off using a separate agent to complete an objective

systemPromptDataobject

Arbitrary data rendered into the variation's system_prompt_template

outputobject

The output of the objective, populated when the objective completes. Will match the schema of output_json_schema or output_json_inferred. This will only be set if the state of the objective is set to STATE_FINALIZED

firstUserMessageDataobject

Arbitrary data rendered into the variation's first_user_message_template

pinnedParametersobject

Parameters forced onto this objective's tool calls, as provided at creation. See CreateObjectiveRequest.pinned_parameters for semantics.