API Reference

Objectives

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List objective events

client.Objectives.ListEvents(ctx, objectiveID, query) (*CursorPagination[ObjectiveListEventsResponse], error)

GET/v1/objectives/{objectiveId}/events

Lists all events for an objective

ParametersExpand Collapse

objectiveID string

query ObjectiveListEventsParams

Cursor param.Field[string]optional

Pagination cursor from previous response

IncludeInfo param.Field[bool]optional

When set to true you may use more of your alloted API rate-limit

Limit param.Field[int64]optional

Maximum number of results to return

formatint32

SortOrder param.Field[string]optional

Sort order for results (asc or desc by creation time)

WindowID param.Field[string]optional

Optional context window ID to filter events by

ReturnsExpand Collapse

type ObjectiveListEventsResponse struct{…}

Data ObjectiveEventData

AssistantMessage AssistantMessageoptional

Content stringoptional

ToolCalls []AssistantToolCalloptional

Arguments stringoptional

FunctionName stringoptional

Tool CallableTooloptional

CallableTool is a union that represents a tool that can be called by an agent. In Cadenya, a tool that is used within an agent objective might be a user-defined tool (IE: MCP, HTTP), another Agent (useful to separate context), or a Cadenya Tool (one Cadenya provides).

Agent ResourceMetadataoptional

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 Time

Timestamp when this resource was created

formatdate-time

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 stringoptional

External ID for the resource (e.g., a workflow ID from an external system)

Labels map[string, string]optional

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

CadenyaProvidedTool ResourceMetadataoptional

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 Time

Timestamp when this resource was created

formatdate-time

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 stringoptional

External ID for the resource (e.g., a workflow ID from an external system)

Labels map[string, string]optional

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

Tool ResourceMetadataoptional

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 Time

Timestamp when this resource was created

formatdate-time

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 stringoptional

External ID for the resource (e.g., a workflow ID from an external system)

Labels map[string, string]optional

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

ContextWindowCompacted ContextWindowCompactedoptional

MessagesCompacted int64optional

Number of messages that were compacted

formatint32

NewContextWindow ObjectiveContextWindowDataoptional

The new context window created by this compaction

CompletionTokens int64optional

A calculated value for how many completion tokens (output tokens) have been used in this context window

formatint32

ObjectiveID stringoptional

The objective's ID that this window belongs to

PreviousWindowContinueInstructions stringoptional

The instructions for this window to continue from a previous window's chat history.

PromptTokens int64optional

A calculated value for how many prompt tokens (input tokens) have been used in this context window

formatint32

Sequence int64optional

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.

formatint32

Strategies []stringoptional

The strategies that were applied during this compaction

Summary stringoptional

The summary generated by the summarization strategy, if used.

Error ObjectiveErroroptional

Message stringoptional

Type stringoptional

SubObjectiveCreated SubObjectiveCreatedoptional

Metadata OperationMetadataoptional

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 Time

Timestamp when this operation was created ULID includes timestamp information, but this explicit field enables easier querying

formatdate-time

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 stringoptional

External ID for the operation (e.g., a workflow ID from an external system)

Labels map[string, string]optional

Arbitrary key-value pairs for categorization and filtering Examples: {"priority": "high", "source": "api", "workflow": "onboarding"}

ToolApprovalRequested ToolApprovalRequestedoptional

ToolCallID stringoptional

The ID of the objective tool call record. Use this ID with the ApproveToolCall or DenyToolCall RPCs to approve or deny the tool call.

ToolApproved ToolApprovedoptional

ToolCallID stringoptional

The ID of the objective tool call record that was approved via the ApproveToolCall RPC.

ToolCalled ToolCalledoptional

ToolCallID stringoptional

The ID of the objective tool call record that was executed.

ToolDenied ToolDeniedoptional

Memo stringoptional

The memo provided by the reviewer when denying the tool call. This is passed to the agent to provide further instructions.

ToolCallID stringoptional

The ID of the objective tool call record that was denied via the DenyToolCall RPC.

ToolError ToolErroroptional

Message stringoptional

ToolCallID stringoptional

The ID of the objective tool call record that encountered an error during execution.

ToolResult ToolResultoptional

Content stringoptional

ToolCallID stringoptional

Type stringoptional

UserMessage UserMessageoptional

Content stringoptional

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 Time

Timestamp when this operation was created ULID includes timestamp information, but this explicit field enables easier querying

formatdate-time

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 stringoptional

External ID for the operation (e.g., a workflow ID from an external system)

Labels map[string, string]optional

Arbitrary key-value pairs for categorization and filtering Examples: {"priority": "high", "source": "api", "workflow": "onboarding"}

ContextWindowID stringoptional

Info ObjectiveEventInfooptional

CreatedBy Profileoptional

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 stringoptional

External ID for the resource (e.g., a workflow ID from an external system)

Labels map[string, string]optional

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

Spec ProfileSpec

ProfileSpec contains the profile-specific fields

Type ProfileSpecType

Type is the type of profile. User's are humans, API keys are computers. You know the deal.

formatenum

One of the following:

const ProfileSpecTypeProfileTypeUser ProfileSpecType = "PROFILE_TYPE_USER"

const ProfileSpecTypeProfileTypeAPIKey ProfileSpecType = "PROFILE_TYPE_API_KEY"

const ProfileSpecTypeProfileTypeSystem ProfileSpecType = "PROFILE_TYPE_SYSTEM"

Email stringoptional

Email address of the user (required, unique per account)

Name stringoptional

Display name for the user (e.g., "Bobby Tables")

Objective OperationMetadataoptional

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 Time

Timestamp when this operation was created ULID includes timestamp information, but this explicit field enables easier querying

formatdate-time

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 stringoptional

External ID for the operation (e.g., a workflow ID from an external system)

Labels map[string, string]optional

Arbitrary key-value pairs for categorization and filtering Examples: {"priority": "high", "source": "api", "workflow": "onboarding"}

List objective events

Go

HTTP

TypeScript

Go

CLI Tool

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cadenya.NewClient(
    option.WithAPIKey("My API Key"),
  )
  page, err := client.Objectives.ListEvents(
    context.TODO(),
    "objectiveId",
    cadenya.ObjectiveListEventsParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

200 example

{
  "items": [
    {
      "data": {
        "assistantMessage": {
          "content": "content",
          "toolCalls": [
            {
              "arguments": "arguments",
              "functionName": "functionName",
              "tool": {
                "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"
                  }
                }
              }
            }
          ]
        },
        "contextWindowCompacted": {
          "messagesCompacted": 0,
          "newContextWindow": {
            "completionTokens": 0,
            "objectiveId": "objectiveId",
            "previousWindowContinueInstructions": "previousWindowContinueInstructions",
            "promptTokens": 0,
            "sequence": 0
          },
          "strategies": [
            "string"
          ],
          "summary": "summary"
        },
        "error": {
          "message": "message",
          "type": "type"
        },
        "subObjectiveCreated": {
          "metadata": {
            "id": "id",
            "accountId": "accountId",
            "createdAt": "2019-12-27T18:11:19.117Z",
            "profileId": "profileId",
            "workspaceId": "workspaceId",
            "externalId": "externalId",
            "labels": {
              "foo": "string"
            }
          }
        },
        "toolApprovalRequested": {
          "toolCallId": "toolCallId"
        },
        "toolApproved": {
          "toolCallId": "toolCallId"
        },
        "toolCalled": {
          "toolCallId": "toolCallId"
        },
        "toolDenied": {
          "memo": "memo",
          "toolCallId": "toolCallId"
        },
        "toolError": {
          "message": "message",
          "toolCallId": "toolCallId"
        },
        "toolResult": {
          "content": "content",
          "toolCallId": "toolCallId"
        },
        "type": "type",
        "userMessage": {
          "content": "content"
        }
      },
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "createdAt": "2019-12-27T18:11:19.117Z",
        "profileId": "profileId",
        "workspaceId": "workspaceId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "contextWindowId": "contextWindowId",
      "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"
          }
        }
      }
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}

Returns Examples

200 example

{
  "items": [
    {
      "data": {
        "assistantMessage": {
          "content": "content",
          "toolCalls": [
            {
              "arguments": "arguments",
              "functionName": "functionName",
              "tool": {
                "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"
                  }
                }
              }
            }
          ]
        },
        "contextWindowCompacted": {
          "messagesCompacted": 0,
          "newContextWindow": {
            "completionTokens": 0,
            "objectiveId": "objectiveId",
            "previousWindowContinueInstructions": "previousWindowContinueInstructions",
            "promptTokens": 0,
            "sequence": 0
          },
          "strategies": [
            "string"
          ],
          "summary": "summary"
        },
        "error": {
          "message": "message",
          "type": "type"
        },
        "subObjectiveCreated": {
          "metadata": {
            "id": "id",
            "accountId": "accountId",
            "createdAt": "2019-12-27T18:11:19.117Z",
            "profileId": "profileId",
            "workspaceId": "workspaceId",
            "externalId": "externalId",
            "labels": {
              "foo": "string"
            }
          }
        },
        "toolApprovalRequested": {
          "toolCallId": "toolCallId"
        },
        "toolApproved": {
          "toolCallId": "toolCallId"
        },
        "toolCalled": {
          "toolCallId": "toolCallId"
        },
        "toolDenied": {
          "memo": "memo",
          "toolCallId": "toolCallId"
        },
        "toolError": {
          "message": "message",
          "toolCallId": "toolCallId"
        },
        "toolResult": {
          "content": "content",
          "toolCallId": "toolCallId"
        },
        "type": "type",
        "userMessage": {
          "content": "content"
        }
      },
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "createdAt": "2019-12-27T18:11:19.117Z",
        "profileId": "profileId",
        "workspaceId": "workspaceId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "contextWindowId": "contextWindowId",
      "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"
          }
        }
      }
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}