## Cancel an objective `client.objectives.cancel(stringobjectiveID, ObjectiveCancelParamsbody, RequestOptionsoptions?): Objective` **post** `/v1/objectives/{objectiveId}/cancel` Cancels a running or pending objective. The objective's state will be set to STATE_CANCELLED. ### Parameters - `objectiveID: string` - `body: ObjectiveCancelParams` - `reason?: string` Optional reason for cancellation ### Returns - `Objective` - `data: ObjectiveData` - `agent?: Agent` Agent resource - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `id: string` Unique identifier for the resource (prefixed ULID, e.g., "agent_01HXK...") - `accountId: string` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `createdAt: string` Timestamp when this resource was created - `name: string` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profileId: string` ID of the actor (user or service account) that created this resource - `workspaceId: string` Workspace this resource belongs to for organizational grouping (prefixed ULID) - `externalId?: string` External ID for the resource (e.g., a workflow ID from an external system) - `labels?: Record` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: AgentSpec` Agent specification (user-provided configuration) - `status: "AGENT_STATUS_UNSPECIFIED" | "AGENT_STATUS_DRAFT" | "AGENT_STATUS_PUBLISHED" | "AGENT_STATUS_ARCHIVED"` Status of the agent - `"AGENT_STATUS_UNSPECIFIED"` - `"AGENT_STATUS_DRAFT"` - `"AGENT_STATUS_PUBLISHED"` - `"AGENT_STATUS_ARCHIVED"` - `variationSelectionMode: "VARIATION_SELECTION_MODE_UNSPECIFIED" | "VARIATION_SELECTION_MODE_RANDOM" | "VARIATION_SELECTION_MODE_WEIGHTED"` Controls how variations are automatically selected when creating objectives Defaults to RANDOM when unspecified - `"VARIATION_SELECTION_MODE_UNSPECIFIED"` - `"VARIATION_SELECTION_MODE_RANDOM"` - `"VARIATION_SELECTION_MODE_WEIGHTED"` - `description?: string` Description of the agent's purpose - `webhookEventsUrl?: string` The URL that Cadenya will send events for any objective assigned to the agent. - `info?: AgentInfo` AgentInfo contains simple information about an agent for display or quick reference - `createdBy?: Profile` Profile represents a human user at the account level. Profiles are account-scoped resources that can be associated with multiple workspaces through the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS). - `metadata: AccountResourceMetadata` AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace. - `id: string` Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...") - `accountId: string` Account this resource belongs to for multi-tenant isolation (prefixed ULID) - `name: string` Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly - `profileId: string` - `externalId?: string` External ID for the resource (e.g., a workflow ID from an external system) - `labels?: Record` Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"} - `spec: ProfileSpec` ProfileSpec contains the profile-specific fields - `type: "PROFILE_TYPE_USER" | "PROFILE_TYPE_API_KEY" | "PROFILE_TYPE_SYSTEM"` Type is the type of profile. User's are humans, API keys are computers. You know the deal. - `"PROFILE_TYPE_USER"` - `"PROFILE_TYPE_API_KEY"` - `"PROFILE_TYPE_SYSTEM"` - `email?: string` Email address of the user (required, unique per account) - `name?: string` Display name for the user (e.g., "Bobby Tables") - `variationCount?: number` - `data?: unknown` Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. - `initialMessage?: string` The initial message sent to the agent. This becomes the first user message in the LLM chat history. - `parentObjectiveId?: string` A parent objective means the objective was spawned off using a separate agent to complete an objective - `secrets?: Array` Secrets that can be used in the headers for tool calls using the secret interpolation format. - `name?: string` - `value?: string` - `systemPrompt?: string` system_prompt is read-only, derived from the selected variation's prompt - `variation?: AgentVariation` AgentVariation resource - `metadata: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `spec: AgentVariationSpec` AgentVariationSpec defines the operational configuration for a variation - `compactionConfig?: AgentVariationSpecCompactionConfig` CompactionConfig defines how context window compaction behaves for objectives using this variation. - `summarization?: CompactionConfigSummarizationStrategy` SummarizationStrategy configures LLM-powered summarization of older conversation turns. - `instructions?: string` Custom instructions that guide what the summarizer preserves. Replaces the default summarization prompt entirely. Example: "Preserve all code snippets, variable names, and technical decisions." - `toolResultClearing?: CompactionConfigToolResultClearingStrategy` ToolResultClearingStrategy configures clearing of older tool result content. - `preserveRecentResults?: number` Number of most recent tool call results to keep intact. Older tool results have their content replaced with "[result cleared]" while preserving the assistant tool call message (function name, arguments). Default: 2 - `triggerThreshold?: number` Trigger threshold as a percentage of the model's context window (0.0 to 1.0). When input tokens reach this percentage of the model's limit, compaction triggers. Default: 0.75 (75%) - `constraints?: AgentVariationSpecConstraints` Execution constraints - `maxSubObjectives?: number` The maximum number of sub-objectives that can be created. 0 means no limit. - `maxToolCalls?: number` The maximum number of tool calls that can be made. 0 means no limit. - `description?: string` Human-readable description of what this variation does or when it should be used - `enableEpisodicMemory?: boolean` Enable episodic memory for objectives using this variation. When true, the system automatically creates a document namespace for each objective using the objective's episodic_key as the external_id, allowing the agent to store and retrieve documents specific to that episode. - `episodicMemoryTtl?: number` How long episodic memories should be retained. After this duration, episodic document namespaces can be automatically cleaned up. If not set, episodic memories are retained indefinitely. - `modelConfig?: AgentVariationSpecModelConfig` ModelConfig defines the model configuration for a variation - `modelId?: string` The model identifier in family/model format (e.g., "claude/opus-4.6", "claude/sonnet-4.5") - `temperature?: number` Sampling temperature for model inference (0.0 to 1.0) Lower values produce more deterministic outputs, higher values increase randomness - `prompt?: string` The system prompt for this variation - `toolSelection?: AgentVariationSpecToolSelection` Tool selection strategy - `assignedTools?: ToolSelectionAssignedTools` AssignedTools is used to indicate that the agent should only use the tools/tool sets that are explicitly assigned to it. Allow discovery is used when the agent thinks it needs to discover more tools. - `allowDiscovery?: boolean` - `autoDiscovery?: ToolSelectionAutoDiscovery` AutoDiscovery is used to indicate that the agent should automatically discover tools that are not explicitly assigned to it. Max tools is the maximum number of tools that can be discovered. Hints are optional hints for tool search. These are used in conjunction with the context-aware tool search and can help select the best tools for the task. - `hints?: Array` - `maxTools?: number` - `weight?: number` Weight for weighted random selection (>= 0). P(v) = v.weight / sum(all_weights). Only used when the agent's variation_selection_mode is WEIGHTED. A weight of 0 means never auto-selected, but can still be chosen explicitly via variation_id on CreateObjectiveRequest. - `info?: AgentVariationInfo` AgentVariationInfo provides read-only summary information about a variation - `assignments?: Array` All tools, tool sets, and sub-agents assigned to this variation. Populated on reads so clients can render a variation's full assignment list without calling the add/remove endpoints just to enumerate. - `id?: string` - `agent?: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `id?: string` - `name?: string` Human-readable name of the referenced resource, populated by the server on reads for convenience. Absent on references to resources that do not have a name (e.g., objective tasks). - `tool?: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `toolSet?: BareMetadata` BareMetadata contains the minimal metadata for a resource: the ID and an optional human-readable name. These are used for reference fields where the full metadata (account scoping, timestamps, labels, external IDs) is not needed — e.g., the tool references inside an agent variation spec or the tools assigned to an objective. Both fields are server-populated; clients provide IDs through sibling fields rather than by constructing a BareMetadata themselves. - `createdBy?: Profile` Profile represents a human user at the account level. Profiles are account-scoped resources that can be associated with multiple workspaces through the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS). - `feedbackCount?: number` Total number of objective feedbacks received for this variation - `model?: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `score?: number` Thompson Sampling score: posterior mean of Beta(ts_alpha, ts_beta). Range [0, 1] where 0.5 = neutral, >0.5 = positive, <0.5 = negative. - `subAgentCount?: number` Number of sub-agents assigned to this variation - `toolCount?: number` Number of individual tools assigned to this variation - `toolSetCount?: number` Number of tool sets assigned to this variation - `metadata: OperationMetadata` Metadata for ephemeral operations and activities (e.g., objectives, executions, runs) - `id: string` Unique identifier for the operation (prefixed ULID, e.g., "obj_01HXK...") - `accountId: string` Account this operation belongs to for multi-tenant isolation (prefixed ULID) - `createdAt: string` Timestamp when this operation was created ULID includes timestamp information, but this explicit field enables easier querying - `profileId: string` ID of the actor (user or service account) that created this operation - `workspaceId: string` Workspace this operation belongs to for organizational grouping (prefixed ULID) - `externalId?: string` External ID for the operation (e.g., a workflow ID from an external system) - `labels?: Record` Arbitrary key-value pairs for categorization and filtering Examples: {"priority": "high", "source": "api", "workflow": "onboarding"} - `status: ObjectiveStatus` - `state: "STATE_UNSPECIFIED" | "STATE_PENDING" | "STATE_RUNNING" | 3 more` - `"STATE_UNSPECIFIED"` - `"STATE_PENDING"` - `"STATE_RUNNING"` - `"STATE_COMPLETED"` - `"STATE_FAILED"` - `"STATE_CANCELLED"` - `message?: string` - `info?: ObjectiveInfo` ObjectiveInfo provides read-only aggregated statistics about an objective's execution - `callableTools?: Array` List of callable tools assigned to the agent for this objective Includes tools, agents, and cadenya-provided tools from the agent's configuration - `agent?: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `cadenyaProvidedTool?: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `tool?: ResourceMetadata` Standard metadata for persistent, named resources (e.g., agents, tools, prompts) - `createdBy?: Profile` Profile represents a human user at the account level. Profiles are account-scoped resources that can be associated with multiple workspaces through the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS). - `totalContextWindows?: number` Total number of context windows that this objective has generated - `totalEvents?: number` Total number of events generated during this objective's execution - `totalInputTokens?: number` Total input tokens consumed across all LLM completions across all context windows - `totalOutputTokens?: number` Total output tokens generated across all LLM completions across all context windows - `totalToolCalls?: number` Total number of tool calls made during execution - `lastFiveWindows?: Array` Read-only list of the last five windows of execution for this objective, ordered by most recent first. Is only included in singular RPC calls (GetObjective, for example). - `data: ObjectiveContextWindowData` - `completionTokens?: number` A calculated value for how many completion tokens (output tokens) have been used in this context window - `objectiveId?: string` The objective's ID that this window belongs to - `previousWindowContinueInstructions?: string` The instructions for this window to continue from a previous window's chat history. - `promptTokens?: number` A calculated value for how many prompt tokens (input tokens) have been used in this context window - `sequence?: number` sequence is a numeric representation of which context window this is. Sequences are useful to perform a max(sequence) on in order to calculate how many context windows an objective has. - `metadata: OperationMetadata` Metadata for ephemeral operations and activities (e.g., objectives, executions, runs) - `info?: Info` - `createdBy?: Profile` Profile represents a human user at the account level. Profiles are account-scoped resources that can be associated with multiple workspaces through the Actor model. Authentication for profiles is handled via SSO/OAuth (WorkOS). - `objective?: OperationMetadata` Metadata for ephemeral operations and activities (e.g., objectives, executions, runs) ### Example ```typescript import Cadenya from '@cadenya/cadenya'; const client = new Cadenya({ apiKey: process.env['CADENYA_API_KEY'], // This is the default and can be omitted }); const objective = await client.objectives.cancel('objectiveId'); console.log(objective.data); ``` #### Response ```json { "data": { "agent": { "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "status": "AGENT_STATUS_UNSPECIFIED", "variationSelectionMode": "VARIATION_SELECTION_MODE_UNSPECIFIED", "description": "description", "webhookEventsUrl": "webhookEventsUrl" }, "info": { "createdBy": { "metadata": { "id": "id", "accountId": "accountId", "name": "name", "profileId": "profileId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "PROFILE_TYPE_USER", "email": "email", "name": "name" } }, "variationCount": 0 } }, "data": {}, "initialMessage": "initialMessage", "parentObjectiveId": "parentObjectiveId", "secrets": [ { "name": "name", "value": "value" } ], "systemPrompt": "systemPrompt", "variation": { "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "compactionConfig": { "summarization": { "instructions": "instructions" }, "toolResultClearing": { "preserveRecentResults": 0 }, "triggerThreshold": 0 }, "constraints": { "maxSubObjectives": 0, "maxToolCalls": 0 }, "description": "description", "enableEpisodicMemory": true, "episodicMemoryTtl": 0, "modelConfig": { "modelId": "modelId", "temperature": 0 }, "prompt": "prompt", "toolSelection": { "assignedTools": { "allowDiscovery": true }, "autoDiscovery": { "hints": [ "string" ], "maxTools": 0 } }, "weight": 0 }, "info": { "assignments": [ { "id": "id", "agent": { "id": "id", "name": "name" }, "tool": { "id": "id", "name": "name" }, "toolSet": { "id": "id", "name": "name" } } ], "createdBy": { "metadata": { "id": "id", "accountId": "accountId", "name": "name", "profileId": "profileId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "PROFILE_TYPE_USER", "email": "email", "name": "name" } }, "feedbackCount": 0, "model": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "externalId": "externalId", "labels": { "foo": "string" } }, "score": 0, "subAgentCount": 0, "toolCount": 0, "toolSetCount": 0 } } }, "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "profileId": "profileId", "workspaceId": "workspaceId", "externalId": "externalId", "labels": { "foo": "string" } }, "status": { "state": "STATE_UNSPECIFIED", "message": "message" }, "info": { "callableTools": [ { "agent": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "externalId": "externalId", "labels": { "foo": "string" } }, "cadenyaProvidedTool": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "externalId": "externalId", "labels": { "foo": "string" } }, "tool": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "name": "name", "profileId": "profileId", "workspaceId": "workspaceId", "externalId": "externalId", "labels": { "foo": "string" } } } ], "createdBy": { "metadata": { "id": "id", "accountId": "accountId", "name": "name", "profileId": "profileId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "PROFILE_TYPE_USER", "email": "email", "name": "name" } }, "totalContextWindows": 0, "totalEvents": 0, "totalInputTokens": 0, "totalOutputTokens": 0, "totalToolCalls": 0 }, "lastFiveWindows": [ { "data": { "completionTokens": 0, "objectiveId": "objectiveId", "previousWindowContinueInstructions": "previousWindowContinueInstructions", "promptTokens": 0, "sequence": 0 }, "metadata": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "profileId": "profileId", "workspaceId": "workspaceId", "externalId": "externalId", "labels": { "foo": "string" } }, "info": { "createdBy": { "metadata": { "id": "id", "accountId": "accountId", "name": "name", "profileId": "profileId", "externalId": "externalId", "labels": { "foo": "string" } }, "spec": { "type": "PROFILE_TYPE_USER", "email": "email", "name": "name" } }, "objective": { "id": "id", "accountId": "accountId", "createdAt": "2019-12-27T18:11:19.117Z", "profileId": "profileId", "workspaceId": "workspaceId", "externalId": "externalId", "labels": { "foo": "string" } } } } ] } ```