Cancel an objective

CLI

cadenya objectives cancel objective_123

package main

import (
	"context"
	"fmt"
	"log"

	cadenya "go.cadenya.com/cadenya-go"
)

func main() {
	client, err := cadenya.NewClient()
	if err != nil {
		log.Fatal(err)
	}
	ctx := context.Background()
	params := &cadenya.ObjectiveCancelParams{}
	result, err := client.Objectives().Cancel(ctx, "objective_123", params)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", result)
}

{
  "metadata": {
    "id": "<string>",
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "labels": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  },
  "configSnapshot": {
    "agent": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "externalId": "<string>",
        "labels": {},
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "variationSelectionMode": "VARIATION_SELECTION_MODE_UNSPECIFIED",
        "description": "<string>",
        "webhookEventsUrl": "<string>",
        "systemPromptDataSchema": {},
        "outputDefinition": {},
        "enableEpisodicMemory": true,
        "episodicMemoryTtl": 123
      },
      "info": {
        "variationCount": 123,
        "createdBy": {
          "metadata": {
            "id": "<string>",
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "name": "<string>",
            "externalId": "<string>",
            "labels": {},
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
            "createdAt": "2023-11-07T05:31:56Z"
          },
          "spec": {
            "email": "<string>",
            "name": "<string>",
            "type": "PROFILE_TYPE_UNSPECIFIED"
          }
        }
      },
      "state": "STATE_UNSPECIFIED"
    },
    "agentVariation": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "externalId": "<string>",
        "labels": {},
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "systemPromptTemplate": "<string>",
        "progressiveDiscovery": {
          "maxTools": 123,
          "hints": [
            "<string>"
          ]
        },
        "constraints": {
          "maxToolCalls": 123,
          "maxSubObjectives": 123,
          "inactivityTimeout": "<string>"
        },
        "description": "<string>",
        "modelConfig": {
          "modelId": "claude/opus-4.6",
          "temperature": 123,
          "topP": 123,
          "topK": 123,
          "stopSequences": [
            "<string>"
          ],
          "maxOutputTokens": 123,
          "reasoningEffort": "REASONING_EFFORT_UNSPECIFIED",
          "cachingEnabled": true
        },
        "compactionConfig": {
          "triggerThreshold": 123,
          "summarization": {
            "instructions": "<string>"
          },
          "toolResultClearing": {
            "preserveRecentResults": 123
          }
        },
        "firstUserMessageTemplate": "<string>"
      },
      "info": {
        "toolCount": 123,
        "toolSetCount": 123,
        "subAgentCount": 123,
        "score": 123,
        "feedbackCount": 123,
        "assignments": [
          {
            "type": "tool",
            "tool": {
              "id": "<string>",
              "name": "<string>"
            },
            "id": "avt_01HXKD2E5NQM3T9AYWCFJE6K89"
          }
        ],
        "memoryLayerAssignments": [
          {
            "id": "avml_01HXKD2E5NQM3T9AYWCFX8AF59",
            "memoryLayer": {
              "id": "<string>",
              "name": "<string>"
            },
            "position": 123
          }
        ],
        "memoryLayerCount": 123,
        "createdBy": {
          "metadata": {
            "id": "<string>",
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "name": "<string>",
            "externalId": "<string>",
            "labels": {},
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
            "createdAt": "2023-11-07T05:31:56Z"
          },
          "spec": {
            "email": "<string>",
            "name": "<string>",
            "type": "PROFILE_TYPE_UNSPECIFIED"
          }
        },
        "model": {
          "id": "<string>",
          "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
          "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
          "name": "<string>",
          "externalId": "<string>",
          "labels": {},
          "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      }
    },
    "agentSchedule": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "externalId": "<string>",
        "labels": {},
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "schedule": {
          "calendars": [
            {
              "second": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "minute": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "hour": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "dayOfMonth": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "month": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "dayOfWeek": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "comment": "<string>"
            }
          ],
          "intervals": [
            {
              "every": "<string>",
              "offset": "<string>"
            }
          ],
          "timezone": "<string>"
        },
        "overlapPolicy": "OVERLAP_POLICY_UNSPECIFIED",
        "firstUserMessage": "<string>",
        "variationId": "agentvar_01HXKD2E5NQM3T9AYWCF32BSPP",
        "systemPromptData": {},
        "firstUserMessageData": {}
      },
      "info": {
        "totalFires": 123,
        "nextFireAt": "2023-11-07T05:31:56Z",
        "lastFireAt": "2023-11-07T05:31:56Z",
        "lastObjectiveId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
        "lastSkippedAt": "2023-11-07T05:31:56Z",
        "lastSkipReason": "<string>",
        "createdBy": {
          "metadata": {
            "id": "<string>",
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "name": "<string>",
            "externalId": "<string>",
            "labels": {},
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
            "createdAt": "2023-11-07T05:31:56Z"
          },
          "spec": {
            "email": "<string>",
            "name": "<string>",
            "type": "PROFILE_TYPE_UNSPECIFIED"
          }
        }
      },
      "state": "STATE_UNSPECIFIED"
    }
  },
  "state": "STATE_UNSPECIFIED",
  "stateMessage": "<string>",
  "systemPrompt": "<string>",
  "firstUserMessage": "<string>",
  "parentObjectiveId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
  "secrets": [
    {
      "name": "<string>"
    }
  ],
  "memoryCascade": [
    {
      "memoryLayerId": "memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH",
      "memoryEntryId": "mementry_01HXKD2E5NQM3T9AYWCF5E52Z0"
    }
  ],
  "pinnedParameters": {},
  "info": {
    "totalEvents": 123,
    "totalToolCalls": 123,
    "totalInputTokens": 123,
    "totalOutputTokens": 123,
    "totalContextWindows": 123,
    "totalIterations": 123,
    "createdBy": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "name": "<string>",
        "externalId": "<string>",
        "labels": {},
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "email": "<string>",
        "name": "<string>",
        "type": "PROFILE_TYPE_UNSPECIFIED"
      }
    },
    "effectiveMemoryCascade": [
      {
        "memoryLayerId": "memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH",
        "memoryEntryId": "mementry_01HXKD2E5NQM3T9AYWCF5E52Z0"
      }
    ],
    "agent": {
      "id": "<string>",
      "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
      "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
      "name": "<string>",
      "externalId": "<string>",
      "labels": {},
      "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "agentVariation": {
      "id": "<string>",
      "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
      "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
      "name": "<string>",
      "externalId": "<string>",
      "labels": {},
      "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "currentContextWindowId": "objwin_01HXKD2E5NQM3T9AYWCFN7BSTR",
    "tenant": {
      "id": "tenant_01HXKD2E5NQM3T9AYWCF133E3Q",
      "externalId": "acme-corp",
      "name": "Acme Corp"
    },
    "subject": {
      "id": "subj_01HXKD2E5NQM3T9AYWCFQAZGFV",
      "externalId": "customer-user-42",
      "name": "Jane Doe"
    },
    "widget": {
      "id": "<string>",
      "name": "<string>"
    }
  },
  "systemPromptData": {},
  "output": {},
  "firstUserMessageData": {},
  "episodicMemory": {
    "key": "<string>",
    "memoryLayerId": "memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

POST

workspaces

{workspaceId}

objectives

{objectiveId}

:cancel

CLI

cadenya objectives cancel objective_123

package main

import (
	"context"
	"fmt"
	"log"

	cadenya "go.cadenya.com/cadenya-go"
)

func main() {
	client, err := cadenya.NewClient()
	if err != nil {
		log.Fatal(err)
	}
	ctx := context.Background()
	params := &cadenya.ObjectiveCancelParams{}
	result, err := client.Objectives().Cancel(ctx, "objective_123", params)
	if err != nil {
		log.Fatal(err)
	}
	fmt.Printf("%+v\n", result)
}

{
  "metadata": {
    "id": "<string>",
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
    "labels": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "externalId": "<string>",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  },
  "configSnapshot": {
    "agent": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "externalId": "<string>",
        "labels": {},
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "variationSelectionMode": "VARIATION_SELECTION_MODE_UNSPECIFIED",
        "description": "<string>",
        "webhookEventsUrl": "<string>",
        "systemPromptDataSchema": {},
        "outputDefinition": {},
        "enableEpisodicMemory": true,
        "episodicMemoryTtl": 123
      },
      "info": {
        "variationCount": 123,
        "createdBy": {
          "metadata": {
            "id": "<string>",
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "name": "<string>",
            "externalId": "<string>",
            "labels": {},
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
            "createdAt": "2023-11-07T05:31:56Z"
          },
          "spec": {
            "email": "<string>",
            "name": "<string>",
            "type": "PROFILE_TYPE_UNSPECIFIED"
          }
        }
      },
      "state": "STATE_UNSPECIFIED"
    },
    "agentVariation": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "externalId": "<string>",
        "labels": {},
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "systemPromptTemplate": "<string>",
        "progressiveDiscovery": {
          "maxTools": 123,
          "hints": [
            "<string>"
          ]
        },
        "constraints": {
          "maxToolCalls": 123,
          "maxSubObjectives": 123,
          "inactivityTimeout": "<string>"
        },
        "description": "<string>",
        "modelConfig": {
          "modelId": "claude/opus-4.6",
          "temperature": 123,
          "topP": 123,
          "topK": 123,
          "stopSequences": [
            "<string>"
          ],
          "maxOutputTokens": 123,
          "reasoningEffort": "REASONING_EFFORT_UNSPECIFIED",
          "cachingEnabled": true
        },
        "compactionConfig": {
          "triggerThreshold": 123,
          "summarization": {
            "instructions": "<string>"
          },
          "toolResultClearing": {
            "preserveRecentResults": 123
          }
        },
        "firstUserMessageTemplate": "<string>"
      },
      "info": {
        "toolCount": 123,
        "toolSetCount": 123,
        "subAgentCount": 123,
        "score": 123,
        "feedbackCount": 123,
        "assignments": [
          {
            "type": "tool",
            "tool": {
              "id": "<string>",
              "name": "<string>"
            },
            "id": "avt_01HXKD2E5NQM3T9AYWCFJE6K89"
          }
        ],
        "memoryLayerAssignments": [
          {
            "id": "avml_01HXKD2E5NQM3T9AYWCFX8AF59",
            "memoryLayer": {
              "id": "<string>",
              "name": "<string>"
            },
            "position": 123
          }
        ],
        "memoryLayerCount": 123,
        "createdBy": {
          "metadata": {
            "id": "<string>",
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "name": "<string>",
            "externalId": "<string>",
            "labels": {},
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
            "createdAt": "2023-11-07T05:31:56Z"
          },
          "spec": {
            "email": "<string>",
            "name": "<string>",
            "type": "PROFILE_TYPE_UNSPECIFIED"
          }
        },
        "model": {
          "id": "<string>",
          "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
          "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
          "name": "<string>",
          "externalId": "<string>",
          "labels": {},
          "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      }
    },
    "agentSchedule": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
        "name": "<string>",
        "externalId": "<string>",
        "labels": {},
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "schedule": {
          "calendars": [
            {
              "second": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "minute": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "hour": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "dayOfMonth": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "month": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "dayOfWeek": [
                {
                  "start": 123,
                  "end": 123,
                  "step": 123
                }
              ],
              "comment": "<string>"
            }
          ],
          "intervals": [
            {
              "every": "<string>",
              "offset": "<string>"
            }
          ],
          "timezone": "<string>"
        },
        "overlapPolicy": "OVERLAP_POLICY_UNSPECIFIED",
        "firstUserMessage": "<string>",
        "variationId": "agentvar_01HXKD2E5NQM3T9AYWCF32BSPP",
        "systemPromptData": {},
        "firstUserMessageData": {}
      },
      "info": {
        "totalFires": 123,
        "nextFireAt": "2023-11-07T05:31:56Z",
        "lastFireAt": "2023-11-07T05:31:56Z",
        "lastObjectiveId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
        "lastSkippedAt": "2023-11-07T05:31:56Z",
        "lastSkipReason": "<string>",
        "createdBy": {
          "metadata": {
            "id": "<string>",
            "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
            "name": "<string>",
            "externalId": "<string>",
            "labels": {},
            "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
            "createdAt": "2023-11-07T05:31:56Z"
          },
          "spec": {
            "email": "<string>",
            "name": "<string>",
            "type": "PROFILE_TYPE_UNSPECIFIED"
          }
        }
      },
      "state": "STATE_UNSPECIFIED"
    }
  },
  "state": "STATE_UNSPECIFIED",
  "stateMessage": "<string>",
  "systemPrompt": "<string>",
  "firstUserMessage": "<string>",
  "parentObjectiveId": "obj_01HXKD2E5NQM3T9AYWCFQAZGFV",
  "secrets": [
    {
      "name": "<string>"
    }
  ],
  "memoryCascade": [
    {
      "memoryLayerId": "memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH",
      "memoryEntryId": "mementry_01HXKD2E5NQM3T9AYWCF5E52Z0"
    }
  ],
  "pinnedParameters": {},
  "info": {
    "totalEvents": 123,
    "totalToolCalls": 123,
    "totalInputTokens": 123,
    "totalOutputTokens": 123,
    "totalContextWindows": 123,
    "totalIterations": 123,
    "createdBy": {
      "metadata": {
        "id": "<string>",
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "name": "<string>",
        "externalId": "<string>",
        "labels": {},
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "spec": {
        "email": "<string>",
        "name": "<string>",
        "type": "PROFILE_TYPE_UNSPECIFIED"
      }
    },
    "effectiveMemoryCascade": [
      {
        "memoryLayerId": "memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH",
        "memoryEntryId": "mementry_01HXKD2E5NQM3T9AYWCF5E52Z0"
      }
    ],
    "agent": {
      "id": "<string>",
      "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
      "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
      "name": "<string>",
      "externalId": "<string>",
      "labels": {},
      "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "agentVariation": {
      "id": "<string>",
      "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
      "workspaceId": "workspace_01HXKD2E5NQM3T9AYWCF133E3Q",
      "name": "<string>",
      "externalId": "<string>",
      "labels": {},
      "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "currentContextWindowId": "objwin_01HXKD2E5NQM3T9AYWCFN7BSTR",
    "tenant": {
      "id": "tenant_01HXKD2E5NQM3T9AYWCF133E3Q",
      "externalId": "acme-corp",
      "name": "Acme Corp"
    },
    "subject": {
      "id": "subj_01HXKD2E5NQM3T9AYWCFQAZGFV",
      "externalId": "customer-user-42",
      "name": "Jane Doe"
    },
    "widget": {
      "id": "<string>",
      "name": "<string>"
    }
  },
  "systemPromptData": {},
  "output": {},
  "firstUserMessageData": {},
  "episodicMemory": {
    "key": "<string>",
    "memoryLayerId": "memlyr_01HXKD2E5NQM3T9AYWCFFFBMJH"
  }
}

{
  "code": 123,
  "message": "<string>",
  "details": [
    {
      "@type": "<string>"
    }
  ]
}

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

reason

string

Optional reason for cancellation

Response

Objective is the data for an objective. It contains the snapshotted fields for the selected agent and variation. Secrets are returned only with their names, and the output definition is copied from the agent's configuration.

metadata

object

required

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

Show child attributes

configSnapshot

object

required

The snapshot of the agent and the variation selected (either explicitly or by sampling) will be set here. Cadenya stores the point-in-time snapshot of the configuration used to start an objective and maintains it throughout the entire lifecycle so that changes to agents and variations in the middle of a cycle don't impact the objective itself

Show child attributes

state

enum<string>

required

read-only

The current lifecycle state of the objective.

Available options:

STATE_UNSPECIFIED,

STATE_PENDING,

STATE_RUNNING,

STATE_WAITING,

STATE_FAILED,

STATE_CANCELLED,

STATE_FINALIZED,

STATE_TIMED_OUT

stateMessage

string

required

read-only

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

systemPrompt

string

required

read-only

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

firstUserMessage

string

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.

parentObjectiveId

string

required

read-only

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

Example:

"obj_01HXKD2E5NQM3T9AYWCFQAZGFV"

secrets

object[]

required

Secrets that can be used in the headers for tool calls using the secret interpolation format.

Show child attributes

memoryCascade

object[]

required

Memory layers/entries layered over the baseline cascade inherited from the selected variation — element-level rules over inherited styles, in CSS terms.

Array order is resolution order: EARLIER elements are more specific and are consulted first. Entries pinned via memory_entry_id behave as single-entry layers at their position.

System-managed layers (e.g., episodic) cannot be referenced here; they attach themselves automatically based on the episodic key.

Size cap: the TOTAL effective cascade (this field + the variation's memory layer assignments) must not exceed 10 entries. A request that would produce a larger cascade is rejected with InvalidArgument.

Show child attributes

pinnedParameters

object

required

read-only

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

Show child attributes

info

object

Read-only aggregated info about this objective's execution

Show child attributes

systemPromptData

object

read-only

Arbitrary data rendered into the variation's system_prompt_template

output

object

read-only

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

firstUserMessageData

object

read-only

Arbitrary data rendered into the variation's first_user_message_template

episodicMemory

object

If the agent variation that is selected has episodic memory enabled, then this key is used to create/update a memory layer specific to the episodic memory. The layer may have a TTL configured by the variation.

Show child attributes

Overview

Tool Sets

Tools

Tool Set Secrets

Agents

Agent Variations

Agent Schedules

Objectives

Widgets

Widget Sessions

Tenants

Memory Layers

Memory Entries

Models

Uploads

Workspaces

Workspace Secrets

Workspace Admin

Accounts

API Keys

Global API Key

AI Provider Keys

Webhook Events

Cancel an objective

Authorizations

Path Parameters

Body

Response